Skip to content

docs: rewrite doc-spec, slim README, add migration guides - #6

Merged
swetjen merged 1 commit into
mainfrom
docs/spec-readme-migration-guides
Jun 17, 2026
Merged

swetjen merged 1 commit into
mainfrom
docs/spec-readme-migration-guides

Conversation

@swetjen

@swetjen swetjen commented Jun 17, 2026

Copy link
Copy Markdown
Owner

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.

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>
@swetjen
swetjen merged commit 831f6a7 into main Jun 17, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant