docs: scaffold Phase 8 documentation site (mdBook + GitHub Pages) - #20
Merged
Merged
Conversation
Adds the mdBook-based documentation site (41 pages across Learn / Guides / Reference / Concepts / Contributing) with the Eclipse theme, GitHub Pages workflow, and a dedicated 5-agent docs harness so future doc work can be orchestrated independently of the implementation team. Why now: Phase 8 of ROADMAP.md requires a public docs site before v1.0. The dual-audience requirement (newcomers + Solana professionals) is solved by splitting tracks rather than mixing tone within pages — Learn assumes zero background and defines every term; Reference is scannable for pros. Highlights: - mdBook config with admonish + mermaid + linkcheck preprocessors - Eclipse palette theme (dark-first, WCAG AA contrast) - GitHub Actions workflow publishing to gh-pages on push to main - Architecture / build-pipeline / scaffolding / plugin diagrams (mermaid) - 5 new agents (docs-architect, docs-tutorial-writer, docs-reference-writer, docs-designer, docs-reviewer) + sunscreen-docs-orchestrator skill Reference pages were synthesized from CLAUDE.md and ROADMAP.md — before public announcement, they should be cross-checked against src/cli/*.rs, src/error.rs, and src/plugin/. See _workspace/docs-review.md (gitignored) for the P1 list. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
|
Warning Review limit reached
More reviews will be available in 5 minutes and 36 seconds. Learn how PR review limits work. Your organization has run out of usage credits. Purchase more in the billing tab. ⌛ How to resolve this issue?After more reviews become available, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans include higher PR review limits than trial, open-source, and free plans. In all cases, reviews become available again over time. During sustained high-volume PR review activity, CodeRabbit may temporarily slow when the next review becomes available. Please see our Fair Usage Limits Policy for further information. ℹ️ Review info⚙️ Run configurationConfiguration used: Organization UI Review profile: ASSERTIVE Plan: Pro Run ID: ⛔ Files ignored due to path filters (2)
📒 Files selected for processing (55)
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 |
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 90c185c43c
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
Codex review on PR #20 flagged that the reference pages were drifting from the real CLI definitions in src/cli/. They had been synthesized from CLAUDE.md / ROADMAP.md rather than read from source, so they advertised flags that don't exist (chain new --programs/--license/--git, wallet show, deploy --network mainnet-beta, --validator surfpool, --frontend react/solid) and would have produced clap parse errors for anyone copy-pasting. This commit rewrites the affected pages against the actual Args structs: - chain.md: NewArgs (--framework/--frontend/--path/--dry-run only), BuildArgs (--headless/--no-codama), ServeArgs (--runtime/--debounce-ms/ --no-frontend), DoctorArgs (--fix-markers only). chain deploy noted as stub; real deploy is the top-level command. - onboarding.md: WalletCmd subcommands (new/list/airdrop/balance/ set-default), positional amount + --cluster for airdrop, balance not show. DeployArgs positional target (localnet/devnet/mainnet) + --yes-i-understand-cost requirement for mainnet. - generate.md: actual flags only (--program/--out-dir/--frontend-path/ --target react|solid|all). Removed invented --rebuild-config/--pretty/ --out. - cli/index.md: real global flags (--workdir/--config/--verbose/--json); removed --no-color and fabricated SUNSCREEN_* env vars. - config/schema.md: rewritten against actual Config / ClustersCfg / RuntimeCfg shape (project.*, clusters.{localnet,devnet,mainnet}, runtime.{engine,port,faucet_sol}). - Guides updated to match: deploy <target> not --network <name>; wallet airdrop <amount> --cluster <name>; chain serve --runtime; vite/next frontend (not react/solid which is hook-target only). Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
…mann-4c45b9 # Conflicts: # CLAUDE.md
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
docs/site/— 41 pages across Learn, Guides, Reference, Concepts, Contributing — built with mdBook + Eclipse theme..github/workflows/docs.ymlto build and deploy to GitHub Pages (https://Pantani.github.io/sunscreen/) on every push tomaintouchingdocs/site/**.docs-architect,docs-tutorial-writer,docs-reference-writer,docs-designer,docs-reviewer) plus thesunscreen-docs-orchestratorskill, so future doc work runs independently of the implementation team.Why
ROADMAP.mdPhase 8 needs a public docs site before v1.0. The brief from @Pantani: "beautiful docs like TMDCP, accessible to people who don't know much about Rust/Solana but also deep enough for professionals."The dual-audience requirement is solved by splitting tracks rather than mixing tone within pages:
What's in the box
docs/site/book.tomlwithmdbook-admonish+mdbook-mermaid+mdbook-linkcheckpreprocessors.theme/favicon.svg+src/assets/logo.svg(sun-rising-over-horizon glyph + Inter wordmark).mdbook buildon every PR (preview), deploy only on push tomain.What reviewers should check
Reference pages were synthesized from
CLAUDE.md+ROADMAP.md, not by reading everysrc/file. Before announcing the site publicly, please cross-check:reference/cli/chain.md— confirmserveflags (--rpc-port,--ws-port,--quiet) againstsrc/cli/chain.rs.reference/cli/onboarding.md— confirmquickstartkinds (token |nft|dao|blog) againstsrc/cli/onboarding/.reference/errors.md— cross-check error code table againstsrc/error.rs.reference/plugin-protocol/index.md— confirm JSON-RPC shapes againstsrc/plugin/.reference/recipes/crud.md— confirm--fieldsparser acceptsoption<T>andvec<T>.Full P1/P2 list in
_workspace/docs-review.md(local, gitignored).Not in this PR (Phase 8 follow-ups)
bash,zsh,fish,pwsh).cargo-distmatrix.favicon.pngcompanion for older browsers.Test plan
mdbook build docs/sitesucceeds locally without warnings (CI will run this on first push).mdbook serve docs/siterenders all 41 pages, sidebar navigation is consistent, dark mode looks right.mainpublishes.🤖 Generated with Claude Code