Repository navigation
docs: align README with repository standard and move long-form material to docs - #10
Merged
Merged
Conversation
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.
Problem: README was about 2550 words with 14 troubleshooting items, over the 1200-word and 3-to-5-item limits, and carried two non-standard sections. Change: restructured to STANDARD section order, cut Troubleshooting to 5 items, trimmed to 1182 words; moved sign-in plumbing, prompt caching, and 6 further failure modes to docs/. Verification: no test asserts on README content; markdownlint clean on README and docs; npm run typecheck and npm test (42/42) pass locally with lib/ unchanged.