docs: Wave B framework-mode reframing — verify the audiobook migration, link the model doc, restore the MCP Apps guidance - #69
Conversation
…rop the JSX-free test's .tsx extension Wave B sweep of the leftovers from the framework-mode migration (#67). skills-starter's README teaches the skills-directory convention but had nowhere to send a reader for the model behind it; docs/framework-mode.md now exists, so point at it there. audiobook-curator's tests/application.test.tsx lost its last JSX when the migration replaced the structural tree with config assertions, and #67 already renamed src/application.tsx to .ts for the same reason.
…ed, in config terms The framework-mode pass (#67) rewrote this README's structural-JSX section around defineRscApplication but deleted the <McpApp> paragraph outright rather than restating it. That left the README teaching `_meta: { ui: { resourceUri } }` as the way a tool binds to its widget with nothing saying where the widget itself is declared, and no note that createRscMcpServer registers tools only. Also point the Applications section at docs/framework-mode.md, which did not exist when this section was last written.
|
commit: |
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. |
1 participant
Wave B of the examples refresh, unblocked by #67 (framework mode). Wave A4 (#68) is a disjoint sibling — it touches only example
agent-bundle.config.ts/package.jsonfiles, none of which appear here.Docs and one file rename only; no behavior changes and no public API surface moves, so no changeset.
B1 — audiobook-curator migration: verified, one leftover swept
#67 delivered the migration as designed. Verified against the audit's expectations by reading the merged state and running
agent-bundle inspect --json, which reportsdiagnostics: []and conventional provenance everywhere it should:src/application.tsx→src/application.ts, adefineRscApplicationcatalog; JSX confined tosrc/result.tsxandsrc/operations/*.tsxmetadata,targets,scriptsprovenancekind: "config"src/mcp/curator.tsmcpServers[0].provenance.kind: "conventional"skills[0].provenance.kind: "conventional", noskills:in configtests/application.test.tsxasserts config structure, not a lowered JSX tree<AgentBundle>language; the A1 quickstart opener,mcp runsection, and pruned maintainer notes are intactThe one leftover: that test file kept its
.tsxextension after losing its last JSX, while #67 renamedsrc/application.tsxto.tsfor exactly that reason. Renamed totests/application.test.ts.Nothing structural to report.
B2 — skills-starter links the model doc
The README teaches the skills-directory convention but had nowhere to send a reader for the model behind it. One line, now that
docs/framework-mode.mdexists.B3 — rsc-runtime README
The reframe the audit scheduled here already landed in #67, which replaced the whole structural-JSX section (the audit's
:79-101) withdefineRscApplicationand the conventionalsrc/cli.ts/src/mcp/<id>.tsentries. The stalecli-entryfixture strings are gone too:tests/plugin-app.test.tswas deleted wholesale and replaced bytests/application.test.ts. No rsc-runtime test teaches a removed element, and none needed editing.What #67 missed is a deletion rather than a stale line. It dropped the
<McpApp>paragraph outright instead of restating it, which left the README teaching_meta: { ui: { resourceUri } }as how a tool binds to its widget with nothing saying where the widget is declared — and no note thatcreateRscMcpServerregisters tools only, so serving the resource is still the author'sregisterResourcecall. Restored in config-mode terms, verified againstAgentBundleMcpApp,examples/mcp-app/agent-bundle.config.ts, andcreateRscMcpServer.The audit also suggested mentioning
AB4735here. It does not belong: rendered skills live entirely inpackages/agent-bundle/src/config/, andAB4735is already documented indocs/framework-mode.mdanddocs/diagnostics.md.Gates
All green locally:
examples/audiobook-curatorpnpm check(validate + build + typecheck + test),packages/rsc-runtimepnpm test(18 passing),pnpm examples:check(all five examples), theexamples-contractintegration test,pnpm typecheck, andpnpm lint.