docs: rework READMEs — narrated quickstart + simplified npm README#37
Merged
Conversation
Break the single setup block into connect / public relation / private relation / mount steps so the access-policy and WinterTC benefits are easier to spot. Co-Authored-By: Claude Opus 4.8 (1M context) <[email protected]>
Fold the two api.gen imports into step 1 and bring the database client
in via `import { db }` where it's used, removing the standalone
connection step.
Co-Authored-By: Claude Opus 4.8 (1M context) <[email protected]>
Lead each quickstart step with its code so attention lands on the snippet, with the prose underneath. Co-Authored-By: Claude Opus 4.8 (1M context) <[email protected]>
Rework packages/apigen/pkg/README.md to match the root README's flow — punchy intro, narrated quickstart, scannable reference — trimming the dense query/response/schema walls. Promote "Send requests" to a numbered step 4 in both READMEs. Co-Authored-By: Claude Opus 4.8 (1M context) <[email protected]>
ilbertt
changed the title
The quickstart snippets and their comments carry the steps on their own, so remove the explanatory paragraphs under each. Fold the WinterTC note into the mount-step comment. Record the "published README links must be absolute" convention in AGENTS.md. Co-Authored-By: Claude Opus 4.8 (1M context) <[email protected]>
Co-Authored-By: Claude Opus 4.8 (1M context) <[email protected]>
Co-Authored-By: Claude Opus 4.8 (1M context) <[email protected]>
Match the root README's package-manager-neutral commands instead of bun-specific ones — apigen runs on Node and Deno too. Co-Authored-By: Claude Opus 4.8 (1M context) <[email protected]>
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.
Reworks both READMEs for approachability:
packages/apigen/pkg/README.md) — simplified to mirror the root's flow: punchy intro, the same narrated quickstart, and a far more scannable reference. Trimmed the dense query-parameter / response / schema walls (~209 lines removed) down to what an npm user needs, with pointers to the examples for the rest.No code changes — docs only.
🤖 Generated with Claude Code