docs: revamp navigation, close plugin coverage gaps, fix binary size claims - #56
Open
olamide226 wants to merge 1 commit into
Open
docs: revamp navigation, close plugin coverage gaps, fix binary size claims#56olamide226 wants to merge 1 commit into
olamide226 wants to merge 1 commit into
Conversation
…claims Full sweep of the docs site for navigability and accuracy: - Merge quick-start.mdx and the near-duplicate examples/quick-no-manifest.mdx into one canonical getting-started tutorial; shrink examples/no-manifest.md to a pointer instead of a third copy of the same content. - Rename examples/nextjs-csr-kubernetes.mdx to nextjs-csr-embedded.mdx to match the actual example folder name on disk. - Add reference/plugins/vite.mdx and reference/plugins/next.mdx documenting repPlugin()/RepScript options and dev-only behavior — previously the Vite and Next.js plugins had no reference page and were under-linked from the framework guides and homepage. - Cross-link the plain-HTML example from frameworks/vanilla.mdx and quick-start.mdx now that it's easier to find. - Fix binary size claims across docs, CLAUDE.md, AGENTS.md, and gateway/README.md: measured the current build (6.9MB darwin/arm64, 7.3MB linux/amd64) and corrected every "~3-5MB"/"~6MB" claim to ~7MB. Also fixes a real spec conformance violation — RFC-0001 R6 required "under 5MB", which the current binary now exceeds; relaxed to "under 8MB" in both spec/REP-RFC-0001.md and its docs mirror. - Add Build-Tool Plugins and Codemod cards to the homepage's Project Components grid — both are real, shipped capabilities that weren't represented there. Claude-Session: https://claude.ai/code/session_01SFPGdCQcXhSzCRRMrkNyyr
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.
Summary
Full sweep of the docs site (Astro Starlight) for navigability and value communication, prompted by four specific gaps: redundant content, under-referenced examples, missing Vite/Next.js plugin coverage, and a stale gateway binary size claim.
quick-start.mdxand the near-duplicateexamples/quick-no-manifest.mdxare merged into one canonical getting-started tutorial (the extra hot-reload/file-watch section was folded in).examples/no-manifest.mdat the repo root shrinks from a full third copy to a short pointer at the docs site.examples/nextjs-csr-kubernetes.mdxrenamed toexamples/nextjs-csr-embedded.mdxto match the actualexamples/nextjs-csr-embedded/folder on disk — no more name mismatch between GitHub and the docs site.examples/simple-html.mdxalready existed but wasn't linked from anywhere a reader would look for it — now cross-linked fromframeworks/vanilla.mdxandquick-start.mdx.@rep-protocol/viteand@rep-protocol/next(both real, published, v0.1.15) were only documented in one guide with no reference page. Addedreference/plugins/vite.mdxandreference/plugins/next.mdx(documentingrepPlugin()/RepScriptoptions and dev-only behavior, sourced from the actual plugin code), a new "Build-Tool Plugins" sidebar group, and cross-links frominstallation.mdx,frameworks/react.mdx, and the homepage.index.mdx,installation.mdx,docker-embedded.mdx,gateway/README.md,CLAUDE.md, andAGENTS.mdnow says ~7MB. This also surfaced a real spec conformance violation — RFC-0001 §R6 required "under 5MB," which the current binary now exceeds — relaxed to "under 8MB" in bothspec/REP-RFC-0001.mdand its docs mirror.Test plan
pnpm buildindocs/completes cleanly (46 pages, no errors/warnings)@rep-protocol/viteand@rep-protocol/nextpackage names/versions against theirpackage.jsonbefore documenting themmake build/make build-linuxrather than trusting the existing doc claims🤖 Generated with Claude Code
https://claude.ai/code/session_01SFPGdCQcXhSzCRRMrkNyyr