docs: rewrite doc-spec, slim README, add migration guides - #6
Merged
Merged
Conversation
Replace the aspirational doc-spec with an enforceable contract, slim the README from 707 to ~195 lines, and add router-migration documentation. - doc-spec.md: rewrite ALL-CAPS plaintext into spec-compliant Markdown that obeys its own rules. Drop unbuilt machinery (SSG, JSON agent-index, versioned URL trees) into an explicit "deferred" section; keep a lighter required frontmatter schema, heading discipline, gofmt-clean language-tagged code, and GitHub-native callouts. - README.md: collapse the two competing "Why RPC" sections into one, add a constraints-as-features table, fix the broken main() indentation, resolve the httpapi voice to "HTTP-native library" (not "legacy"), and move both cookbooks into the docs tree. - docs/rpc/patterns.md, docs/http-legacy/patterns.md: new cookbook pages holding the RPC and httpapi advanced patterns extracted from the README. - docs/tutorials/coming-from-routers.md: new guide for porting gin/echo/chi/ fiber/net-http services, with a concept map, before/after recipes, an accessor map, and an agent port prompt. - overview.md, tutorials/overview.md: point at the new migration guide and fill the tutorials index. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
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.
Replace the aspirational doc-spec with an enforceable contract, slim the README from 707 to ~195 lines, and add router-migration documentation.