Repository navigation
Make the README a landing page; move the reference to docs/ - #125
Merged
Merged
Conversation
The README was 1,263 lines and opened into authentication details. It now says what the service is, shows one request and its response, maps the architecture to packages, lists the engineering choices that are easy to miss from outside, and points at how to run and develop it, in about 180 lines. It also states the AI-assisted development practice and the all-rights-reserved terms. The reference moved verbatim: lines 8-830 (authentication through caching) to docs/api-reference.md, lines 831-1263 (getting started through testing) to docs/operations.md. Each got a short header and the two cross-file anchors were repointed. AGENTS.md and the adding-features skill now name the docs file to update instead of README. Assisted-by: Claude Fable 5.1
|
Warning Review limit reachedYou've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository. Next included review available in 34 minutes. View limit details
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
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 was 1,263 lines of API reference that opened into authentication details. Public repos with hosted docs keep the README as a landing page and the reference elsewhere; this does that.
New
README.md(153 lines)Badges (build, Go version, release, Go Report Card), what the service is, links to the live docs and OpenAPI document, one request with a trimmed real response, an architecture sketch mapped to packages, the engineering choices worth knowing (failures never cached, safenet, hashed keys and rotation, webhook billing, the usage drift test,
sactl,docs/decisions.md), how to run it locally, how to develop it, a paragraph on AI-assisted development and theAssisted-by:trailer, a documentation map, and the all-rights-reserved notice.Every field name in the example response was checked against
internal/domain/model.goand the reference tables.docs/docs/api-reference.md: README lines 8–830 verbatim (authentication, plans, rate limits, endpoints, response fields, caching) with a short header.docs/operations.md: README lines 831–1263 verbatim (configuration, database, running, make targets, deployment, Fly secrets,sactl, smoke keys, scripts, alerting, billing, testing) with a short header. Its two links into the reference now point atapi-reference.md#….The move was done with
sed -nso the text is byte-identical; only the headers and the two anchors are new.Pointers updated
AGENTS.md: the "keep README in sync" convention now names which docs file each kind of change touches..claude/skills/adding-features/SKILL.md: both checklists namedocs/api-reference.mdanddocs/operations.mdinstead of README.Verification
make verifypasses. Every relative link in the three files resolves to a file, and every cross-file anchor matches a heading. The Go Report Card badge will show a grade after its first visit.