Repository navigation
docs: split the README into a short overview and a docs directory - #42
Merged
Merged
Conversation
The README had grown to 463 lines. Someone deciding whether to use this package had to scroll past a rate limiting guide, a biomarker pack explanation and an error taxonomy before reaching anything that helped them decide. It is now 94 lines: what this is, how to install it, one working example, what the client does for you, the services, and links. The 100 foot view. Everything else moved to docs/, one page per topic, indexed by docs/README.md. The content is unchanged, only relocated, with headings promoted a level so each page reads as a page rather than as an excerpt. Records the rule in AGENTS.md so the README does not grow back.
Merged
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
1 participant
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.
The README had grown to 463 lines. Someone deciding whether to use this package had to scroll past a rate limiting guide, a biomarker pack explanation and an error taxonomy before reaching anything that helped them decide.
Now
README: 94 lines. What this is, how to install it, one working example, what the client does for you, the services table, and links.
docs/: 12 pages, indexed bydocs/README.md:measurements.mdpagination.mdsleep.mderrors.md(errors and rate limits)heart.mdapi-plans.mdusers-and-devices.mdsignature-auth.mdnotifications.mdapi-reference.mdauthentication.mdThe content is unchanged, only relocated, with headings promoted a level so each page reads as a page rather than an excerpt. Every internal link is checked by a script in this branch: zero broken.
Two things worth noting
The npm tarball still ships the README and nothing else new, verified by packing.
docs/is not infiles, so it stays a repository concern rather than bloating what consumers download.This is a
docs:commit, so it cuts no release. That is the policy from the previous PR working as intended: the restructure reaches npm with the next real change rather than publishing a version on its own.I also recorded the rule in
AGENTS.md, so the README does not grow back one section at a time, which is exactly how it got to 463 lines.