Repository navigation
docs(console): split near-cap console reference and flow pages - #3013
Conversation
reference/console.md (2478 words), reference/console/create-and-deploy.md (2491), flows/platform-console.md (2497) and flows/platform-console/agent-editing.md (2491) sat at the 2500-word cap. - reference/console.md: "Inspect detail, versions, and channel drafts" moves to reference/console/versions-and-channel-drafts.md; the heading and its anchor alias stay with a pointer. - reference/console/create-and-deploy.md: repository discovery, access levels and recovery, plus "Use repositories and Slack on the same Agent", move to reference/console/repository-access.md; the Slack heading stays with a pointer. - flows/platform-console.md: the Create Agent form trace from step 3 moves to flows/platform-console/agent-creation.md. - flows/platform-console/agent-editing.md: steps 7 and 8 (stop, deletion), their diagram edges and debugging bullets move to flows/platform-console/agent-stop-and-deletion.md. - Register the pages in docs.json and runtime-flows.md; point direct links at the new pages. - Restore text trimmed on 10-19 that is still accurate: the build commit is baked into the console HTML, the model Secret choice and "Other settings remain" in Create Agent step 3, and the Backends empty-list wording. Moved text is verbatim apart from relative link paths.
Keep the general creation-recovery paragraph in create-and-deploy (presets pages link there); name the real plugin discovery module; scope the model Secret step to methods that show the picker; say the build bakes its source commit; clarify the moved outage reference and step numbering; label the stop and delete diagram nodes; list the stop and deletion trace in Related docs.
…-editing Steps 7 and 8 keep their headings and historical span IDs on the Agent editing flow with links to the new trace, so existing section URLs resolve.
|
🦞👀 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. |
|
Codex review: needs maintainer review before merge. What this changesThis PR splits four console reference and flow pages into focused child pages and updates navigation and incoming links. Example: A reader opens the console reference at #inspect-detail-revisions-and-channel-drafts.
Review scores
ProductKind: Docs · Worth it: Yes · Fix scope: Complete Merge readiness✅ Ready for maintainer review Keep this PR open: the documentation split provides useful room for console changes, preserves existing section links, and introduces no actionable defect found in review. Priority: P3 Before mergeNone. FindingsNone. Agent review detailsHow this fits togetherMarkdown reference and flow pages enter the documentation renderer through docs.json; readers receive linked console guidance and source execution traces. flowchart TD
A[Console documentation] --> B[Reference child pages]
A --> C[Runtime flow child pages]
B --> D[Documentation navigation]
C --> D
D --> E[Reader]
Technical reviewBest possible solution: Land the focused documentation split with preserved section URLs and one owning page for each moved topic. Do we have a high-confidence way to reproduce the issue? This is documentation maintenance; the pinned base pages and prior word-cap trims establish the stated maintenance problem without a runtime reproduction. Is this the best way to solve the issue? The splits follow existing topic boundaries, preserve consequential guidance and old anchors, and update navigation; the remaining longer pages each retain a coherent reference or execution trace. AGENTS.md: found and applied where relevant. Codex review notes: model internal, reasoning medium; reviewed against 52c1a20a792d. Provenance checked
SecurityNone. EvidenceWhat I checked:
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 Reviewed October 20, 2026, 1:47 AM ET / 05:47 UTC. |
Problem
Four console pages sat at the 2,500-word docs cap (
scripts/docs-site/word-count.mjs), so console fixes had to trim reference and flow text to fit:reference/console.md(2478),reference/console/create-and-deploy.md(2491),flows/platform-console.md(2497) andflows/platform-console/agent-editing.md(2491).Change
Mechanical splits along existing seams. Moved text is verbatim apart from relative link paths, and existing heading anchors stay on the original pages.
reference/console.md: "Inspect detail, versions, and channel drafts" moves toreference/console/versions-and-channel-drafts.md. The heading and itsinspect-detail-revisions-and-channel-draftsalias stay, with a pointer.reference/console/create-and-deploy.md: repository discovery, access levels, policy checks and repository recovery, plus "Use repositories and Slack on the same Agent", move toreference/console/repository-access.md. The general creation-recovery paragraphs stay, and so does the Slack heading, with a pointer.flows/platform-console.md: the Create Agent form trace from step 3 (plugin fields and discovery, model choices, starter template, repository options, provisioning, ordinary drafts, Secret grants, harness authentication) moves toflows/platform-console/agent-creation.md.flows/platform-console/agent-editing.md: steps 7 and 8 (stop, deletion), their diagram edges and their debugging bullets move toflows/platform-console/agent-stop-and-deletion.md. The step headings and their span IDs stay, with links.docs.json(hidden, next to their siblings) andcontributing/runtime-flows.md. Direct links in the guides, the Slack integration page, repository credentials and the Storybook workflows now point at the new pages.agents/plugin-discovery.mjs:createPluginDiscovery(loadCatalog,loadTools). The oldcreate.mjs:loadPluginCatalogdoes not exist.Word counts after: console 1566, versions-and-channel-drafts 977, create-and-deploy 2095, repository-access 496, platform-console 2109, agent-creation 673, agent-editing 2033, agent-stop-and-deletion 648.
Verification
node scripts/docs-site/word-count.mjs: ok.node scripts/docs-site/build.mjs --check: validated 269 pages and 4253 links.node scripts/check-specs.mjs: ok.prettier --checkon the touched Markdown;git diff --checkclean.Risks
Open PRs that edit moved paragraphs will conflict and need the same edit applied in the new page. #2833 touches the "Ordinary drafts" paragraph, which now lives in
flows/platform-console/agent-creation.md. #2999, #2268 and #1605 add no new conflicted file beyond what they already have against main (git merge-tree).