docs: complete convention-first guides, targets, and capability navigation (EN/ZH) - #754
Conversation
|
commit: |
Second documentation audit passRe-audited the Rspress site against the current target registry, pinned capability records, generated reference ownership, package/install APIs, and the branch's actual changed-file inventory. The branch already contains the broader work requested here: 24 bilingual files, including a dedicated Verified the author-facing map explicitly covers all five built-in output targets: Two stale generated/compiler-reference sources remain outside this PR's focused rewrite and now have dedicated issues:
Do not hand-edit generated Current head after cleanup is |
Codex Review SummaryThis comment shows the latest Codex review activity on this pull request.
ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings. |
Completes the convention-first onboarding path on the docsite in both locales: one authoritative
Quick start that adds a tool by writing a route file, a capability map that separates compiled
output from client behavior, and reference/troubleshooting pages that send an author to the
existing generated matrices instead of a second hand-maintained one.
Pages added:
guide/start/capabilities,guide/authoring/reuse-framework,guide/development/troubleshooting(en + zh, with matching_meta.jsonnavigation). Pagesrewritten:
guide/start/{index,quick-start,project-structure},guide/distribution/index,reference/{index,targets-artifacts}.Docs-only: no publishable package changes, so no changeset (
skip-changeset).Local gate (authoritative)
Run on
867d3787fb, which contains currentorigin/main:pnpm buildpnpm typecheckpnpm lintpnpm test:unitpnpm docs:site:buildTutorial and Twoslash acceptance
Twoslash is a real gate, verified by falsification rather than assumed: with an unresolvable
import in the Quick start's
defineConfigsample the docsite build fails(
[@rspress/plugin-twoslash] Twoslash error in code … 2307, exit 1). All ten twoslash blocks inthis PR compile against the built declarations. (A first attempt at falsification — an extra
key in the
defineConfigobject — correctly did not fail, becausedefineConfigis genericand infers the literal type.)
The Quick start's "add your first tool" journey was executed end to end against a copy of the
mcp-servertemplate, using the page's exact code:src/mcp/status/tools/hello.tsx(route file only, no registration edit) →validatesucceeds.renderRoute('tool:status/hello', { input: { name: 'Ada' } })→resultis{ message: 'Hello, Ada.' }, passing in the template's ownroute-unitpool.hello.cli.tswithcommand: ['hello']→buildemits the routed bin, andnode artifact/bin/<plugin>.mjs hello --name AdaprintsHello, Ada.agent-bundle --versionand the documentedinspect --artifact/--rootexclusivity(
option '--artifact <path>' cannot be used with option '--root <root>') match thetroubleshooting page.
Deslop
Deslop: gpt-5.6-sol-max + claude-fable-5-1-thinking-xhigh, 6 edits. Removed a duplicated
capability matrix that would have forked the generated host reference, an unused
import React from 'react'in a route sample, and renamed the example server fromtoolstogreeterso the sample path no longer readssrc/mcp/tools/tools/hello.tsx.Self-review
Reviewers:
claude-fable-5-1-thinking-xhighandgpt-5.6-sol-max(full diff), thengpt-5.6-sol-maxagain on the fix commit.validate --target ampovertemplates/mcp-serverfails withamp.mcp.generated-local867d3787fb: Quick start and the capability map now name the failure and point an Amp project atminimalor at a remote/globally resolvable command server beside exactly one Skillminimalandmcp-serversetprivate: true;cli-toolis publishable as scaffolded867d3787fb(en + zh)23d6bdc343) — the page now links the generated pagesreference/targets-artifactsConfirmation pass on
867d3787fb: no blocking or non-blocking findings.The scaffolder gap this PR documents (
--targets amprejected at project creation) is#745; the follow-up closes it in
source and updates these paragraphs.