Skip to content

docs(console): split agent detail tabs and storybook agent workflows into own pages - #3005

Merged
freeqaz merged 3 commits into
mainfrom
docs-split-console-guides
Oct 20, 2026
Merged

freeqaz merged 3 commits into
mainfrom
docs-split-console-guides

Conversation

@freeqaz

@freeqaz freeqaz commented Oct 20, 2026 •

Copy link
Copy Markdown
Collaborator

Problem

docs/guides/console/agent-details.md (2496 words) and docs/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 new guides/console/configuration-plugins-and-files.md, the same shape as the existing channels-and-credentials.md. Each tab heading stays on the detail page with a one-line summary and link, so #configuration-tab, #plugins-tab and #workspace-files-tab still resolve. Restores "Stable" in the agt_… row, dropped on 10-19.
  • contributing/console-storybook.md: the Agent workflow stories (Create and deploy through Delete) move to a new contributing/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.json lists both new pages next to their parents; contributing/README.md, guides/deploy/native-admin.md, guides/topics/plugins-configure.md and reference/console/create-and-deploy.md link 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

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.

…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.
@freeqaz
freeqaz requested a review from a team as a code owner October 20, 2026 04:48
@clawsweeper

clawsweeper Bot commented Oct 20, 2026 •

Copy link
Copy Markdown
Contributor

🦞👀
ClawSweeper picked this up.

Pull request received. I will update this pull request when review starts.

ClawSweeper review complete

ClawSweeper finished reviewing this revision. The review result is being finalized.

View the workflow run.

@clawsweeper clawsweeper Bot added the clawsweeper:intake:docs Preliminary submission classification; full source review pending. label Oct 20, 2026
… 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 clawsweeper Bot added P3 Low-risk cleanup, docs, polish, ergonomics, or speculative feature. rating: 🐚 platinum hermit Good normal PR readiness with ordinary maintainer review expected. status: ⏳ waiting on author ClawSweeper has contributor-facing work open and is waiting for author action. and removed clawsweeper:intake:docs Preliminary submission classification; full source review pending. labels Oct 20, 2026
@freeqaz

freeqaz commented Oct 20, 2026

Copy link
Copy Markdown
Collaborator Author

@clawsweeper re-review

@clawsweeper

clawsweeper Bot commented Oct 20, 2026 •

Copy link
Copy Markdown
Contributor

🦞👀
Exact review queued.

Re-review progress:

@clawsweeper clawsweeper Bot added clawsweeper:intake:docs Preliminary submission classification; full source review pending. and removed clawsweeper:intake:docs Preliminary submission classification; full source review pending. labels Oct 20, 2026
@clawsweeper

clawsweeper Bot commented Oct 20, 2026 •

Copy link
Copy Markdown
Contributor

Codex review: needs maintainer review before merge.

What this changes

This 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.

  • Before: The workflow appears inside the nearly full Storybook guide.
  • After: The same anchor leads to a pointer linking to the workflow’s dedicated page.

Review scores

Measure Result What it means
Overall readiness 🐚 platinum hermit (4/6) A useful, focused documentation split with the prior finding fixed and successful exact-head Static Checks.
Proof confidence 🌊 off-meta tidepool Not applicable: Documentation-only changes are outside the runtime-proof gate; inspected screenshots show unrelated Console refusal states, and the manifest reports unavailable ffprobe for unrelated videos.
Patch quality 🐚 platinum hermit (4/6) No actionable review findings were identified.

Product

Kind: Docs · Worth it: Yes · Fix scope: Complete
User problem: Two Console documentation pages have almost no room for updates under the enforced word limit.
Reason: The collaborator-authored split creates useful operator and contributor pages; the remaining longer pages retain coherent subjects, and existing links continue to resolve.

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
Reviewed head: f6259082b096300728de301c66a807077df817b4

Before merge

None.

Findings

None.

Agent review details

How this fits together

The 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
Loading

Technical review

Best 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

Security

None.

Evidence

What I checked:

  • Introduced change: The pinned introduction diff contains documentation and navigation changes only; the Configuration, Plugins, workspace, and Storybook instructions retain their substantive text and limits. (f6259082b096)
  • Prior finding resolved: The latest commit restores all nine moved Storybook headings and both historical Secret-section aliases on the original page, each with a destination link. (docs/contributing/console-storybook.md:113, f6259082b096)
  • Established documentation pattern: The merged precedent docs: split five near-cap pages along section seams #691 split near-cap pages while retaining original headings as pointers, including the Agent detail guide’s channels and credentials sections. (e81693b504b5)
  • Exact-head validation: Static Checks succeeded for the reviewed head; additional runtime checks were still running, with no failed check returned at inspection. (f6259082b096)
  • Feature history and current-main context: History identifies the original Storybook addition, later Configuration and plugin work, and ongoing shared documentation maintenance; current main still contains the sections in their original guides. Following older Agent detail history eventually encounters an unavailable promisor object, without affecting the verified diff or ownership evidence. (docs/contributing/console-storybook.md:1, 166def51e1c5)

Likely related people:

  • Free Wortley: Raw commit 3411e63 adds docs/contributing/console-storybook.md:3 relative to its recorded parents. This identifies author metadata, not feature responsibility or a PR merger. (role: source-line author; confidence: high; commits: 3411e63ba44d; files: docs/contributing/console-storybook.md)
  • Kevin: Raw commit f2b1431 adds docs/contributing/console-storybook.md:1 relative to its recorded parents. This identifies author metadata, not feature responsibility or a PR merger. (role: source-line author; confidence: high; commits: f2b14314188a; files: docs/contributing/console-storybook.md)
  • stevenlee-oai: Raw commit 33646c3 adds docs/contributing/console-storybook.md:6 relative to its recorded parents. This identifies author metadata, not feature responsibility or a PR merger. (role: source-line author; confidence: high; commits: 33646c3738a9; files: docs/contributing/console-storybook.md)

Labels

Label changes:

  • add status: 👀 ready for maintainer look: ClawSweeper has no concrete contributor-facing blocker left for this PR.
  • remove status: ⏳ waiting on author: Current PR status label is status: 👀 ready for maintainer look.

Label justifications:

  • P3: This is documentation maintenance that creates room for future updates without changing runtime behavior.
  • rating: 🐚 platinum hermit: Overall readiness is 🐚 platinum hermit; proof is 🌊 off-meta tidepool and patch quality is 🐚 platinum hermit.
  • status: 👀 ready for maintainer look: ClawSweeper has no concrete contributor-facing blocker left for this PR.

Rating scale

6/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.

Workflow

ClawSweeper edits this one comment on every review. Comment @clawsweeper re-review for a fresh review only. Repair and merge execution lanes are retired.

History

Review history (1 earlier review cycle)
  • reviewed 2026-10-20T05:26:36.526Z sha 4572d70 :: needs changes before merge. :: [P3] Preserve the moved Storybook workflow anchors on the original page

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.
@freeqaz

freeqaz commented Oct 20, 2026

Copy link
Copy Markdown
Collaborator Author

@clawsweeper re-review

@clawsweeper

clawsweeper Bot commented Oct 20, 2026 •

Copy link
Copy Markdown
Contributor

🦞👀
Exact review queued.

Re-review progress:

@clawsweeper clawsweeper Bot added clawsweeper:intake:docs Preliminary submission classification; full source review pending. status: 👀 ready for maintainer look ClawSweeper has no concrete contributor-facing blocker left for this PR. and removed status: ⏳ waiting on author ClawSweeper has contributor-facing work open and is waiting for author action. clawsweeper:intake:docs Preliminary submission classification; full source review pending. labels Oct 20, 2026
@freeqaz
freeqaz merged commit 8fe865c into main Oct 20, 2026
61 checks passed
@freeqaz
freeqaz deleted the docs-split-console-guides branch October 20, 2026 05:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

P3 Low-risk cleanup, docs, polish, ergonomics, or speculative feature. rating: 🐚 platinum hermit Good normal PR readiness with ordinary maintainer review expected. status: 👀 ready for maintainer look ClawSweeper has no concrete contributor-facing blocker left for this PR.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant