Repository navigation
docs(console): split agent detail tabs and storybook agent workflows into own pages - #3005
Conversation
…ows into their own pages The Agent detail guide (2496 words) and the Console Storybook guide (2499) sat at the 2500-word cap, so each console change had to trim guide text. - Move the Configuration, Plugins, and Workspace files tab sections of guides/console/agent-details.md to guides/console/configuration-plugins-and-files.md, mirroring channels-and-credentials.md; agent-details keeps a short pointer under each tab heading so its anchors still resolve. - Move the Agent workflow stories (create and deploy through Delete) of contributing/console-storybook.md to contributing/console-storybook-agent-workflows.md. - Add both pages to docs.json and point direct links at the new page. - Restore "Stable" in the Agent identifier row. Text moves verbatim; no facts removed.
|
🦞👀 Pull request received. I will update this pull request when review starts. ClawSweeper review completeClawSweeper finished reviewing this revision. The review result is being finalized. |
… the Storybook namespace section Internal review follow-ups: create-and-deploy's deploy step still linked the agent-details stub; plugins-configure's link text now names the Plugins tab; the Storybook section left behind covers Namespace navigation, so retitle it and keep the old anchor as an alias.
|
@clawsweeper re-review |
|
🦞👀 Re-review progress:
|
|
Codex review: needs maintainer review before merge. What this changesThis PR moves Agent editing instructions and Storybook Agent workflows into dedicated pages while preserving existing section links. Example: A contributor opens console-storybook.md#create-and-deploy.
Review scores
ProductKind: Docs · Worth it: Yes · Fix scope: Complete Merge readiness✅ Ready for maintainer review Keep this PR open: the documentation split is useful, and the latest commit resolves the prior anchor finding; no actionable defects remain. Priority: P3 Before mergeNone. FindingsNone. Agent review detailsHow this fits togetherThe documentation site consumes Markdown and navigation metadata to produce browsable operator guides and contributor workflows. flowchart LR
Reader[Documentation reader] --> Parent[Existing guide and anchors]
Parent --> Editing[Agent editing guide]
Parent --> Workflows[Storybook Agent workflows]
Navigation[Site navigation] --> Editing
Navigation --> Workflows
Technical reviewBest possible solution: Land the focused documentation split with the restored original anchors and direct navigation links. Do we have a high-confidence way to reproduce the issue? The source diff establishes the documentation reorganization, and comparison with the earlier reviewed head confirms that the missing anchors were restored. Is this the best way to solve the issue? The split follows an existing repository pattern, preserves instructions and links, and keeps operator guidance separate from contributor walkthroughs. AGENTS.md: found and applied where relevant. Codex review notes: model internal, reasoning medium; reviewed against 166def51e1c5. Provenance checked
SecurityNone. EvidenceWhat I checked:
Likely related people:
LabelsLabel changes:
Label justifications:
Rating scale6/6 🦀 challenger crab · 5/6 🦞 diamond lobster · 4/6 🐚 platinum hermit · 3/6 🦐 gold shrimp · 2/6 🦪 silver shellfish · 1/6 🧂 unranked krab. Overall follows the weaker of proof and patch quality; ✨ marks media proof (a screenshot, video, or linked artifact) that directly shows the changed behavior. WorkflowClawSweeper edits this one comment on every review. Comment HistoryReview history (1 earlier review cycle)
Reviewed October 20, 2026, 1:31 AM ET / 05:31 UTC (Revision 2). |
…al page Each moved Agent workflow section keeps its heading (and the two historical aliases) on console-storybook.md with a link to its new home, so copied section URLs still resolve.
|
@clawsweeper re-review |
|
🦞👀 Re-review progress:
|
Problem
docs/guides/console/agent-details.md(2496 words) anddocs/contributing/console-storybook.md(2499) sat at the 2,500-word docs cap (scripts/docs-site/word-count.mjs). Each console change that touched them had to trim guide text to fit.Change
Mechanical splits along existing seams; text moves verbatim and no facts are removed.
guides/console/agent-details.md: the Configuration, Plugins, and Workspace files tab sections move to a newguides/console/configuration-plugins-and-files.md, the same shape as the existingchannels-and-credentials.md. Each tab heading stays on the detail page with a one-line summary and link, so#configuration-tab,#plugins-taband#workspace-files-tabstill resolve. Restores "Stable" in theagt_…row, dropped on 10-19.contributing/console-storybook.md: the Agent workflow stories (Create and deploy through Delete) move to a newcontributing/console-storybook-agent-workflows.md; the parent keeps each moved heading (and the two historical anchor aliases) with a link to its new section, so copied URLs still resolve. The section left behind covers Namespace navigation, so it is retitled "Namespace navigation and Agent flows" with the old anchor kept as an alias.docs.jsonlists both new pages next to their parents;contributing/README.md,guides/deploy/native-admin.md,guides/topics/plugins-configure.mdandreference/console/create-and-deploy.mdlink to the new pages directly.Word counts after: agent-details 1823, configuration-plugins-and-files 767, console-storybook 1103, console-storybook-agent-workflows 1502.
Verification
node scripts/docs-site/word-count.mjs: ok, no page over the cap.node scripts/docs-site/build.mjs --check: validated 265 pages and 4218 links.node scripts/check-specs.mjs: ok.prettier --checkon the touched Markdown;git diff --checkclean.git merge-treeagainst open PRs touching these pages (feat(console): move Share Agent into an Access tab #2999, fix(console): offer Create Namespace again after Refresh #3002, fix(console): let the create preflight carry any configuration both creates accept #2833, fix(worker): settle initial provisioning on a superseding deploy or stop #2268, feat(iam): grant the deployer exact read of the revision a deploy admits #1605): no conflicted file beyond what each already has against main.Risks
External links to the old anchors keep working through the stub headings. Open PRs that edit the moved sections will conflict on rebase; the resolution is to apply the same edit in the new page.