docs: move CPU throttling guide out of the README - #40
Merged
Merged
Conversation
The README keeps a short pointer and the example; the config key, output, and flake-hunting notes live in docs/cpu-throttling.md, next to the sharding and layout snapshot pages. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
TWD Contract Validation
23 passed · 41 failed · 3 warnings · 1 skipped Failed validations./contracts/users-3.0.json
./contracts/posts-3.1.json
./contracts/products-3.0.json
./contracts/events-3.1.json
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Why
#37 added a long "Reproducing CI-only timing flakes" section to the README. As noted in the review there, it is too much detail for the README.
What changes
docs/cpu-throttling.mdwith the full section, unchanged: the config key, what a throttled run prints, and the notes on looping, retries and timeouts.cpuThrottlerow in the config table links to the new page instead of the removed anchor.CLAUDE.mdpoints at the new page where it mentioned "the throttling notes in the README".Docs only, no code changes.