Skip to content

Skills/docs authoring orchestrator#3452

Open
mschristensen wants to merge 4 commits into
mainfrom
skills/docs-authoring-orchestrator
Open

Skills/docs authoring orchestrator#3452
mschristensen wants to merge 4 commits into
mainfrom
skills/docs-authoring-orchestrator

Conversation

@mschristensen

@mschristensen mschristensen commented Jun 30, 2026

Copy link
Copy Markdown
Contributor

What

Brings the plan → write → review-loop orchestrator pattern to the docs,
decomposes the write-docs monolith, and moves the docs-writing guidance into
folder AGENTS.md files. Skill names mirror ably-ai-transport-js
(docs-review-all + docs-review-*, like code-review-all + code-review-*).
The shared review contract (review-conventions) and change resolver
(code-resolve-changes) load from ably-os over the Ably MCP (ably/ably-os#1608).

Guidance → folder AGENTS.md

The 506-line write-docs/SKILL.md is retired; its guidance now lives with the
content it governs and auto-loads when an agent edits those pages:

  • src/pages/docs/AGENTS.md — structure/IA principles, feature-page tiers,
    page-type templates, the API-reference standard, code-accuracy, verification.
  • src/pages/docs/ai-transport/AGENTS.md — AI Transport positioning + terminology.

Skills no longer vendor guidance; docs-write applies the folder AGENTS.md, and
the docs-review-* concerns read it to check against.

Skills

Skill Role
docs-plan change (SDK release/PR/commits/local, via code-resolve-changes) → docs-plan.md of single-purpose page units
docs-write executor/orchestrator: draft per the folder AGENTS.md → review loop → PASS
docs-review-all fan out the concerns across subagents → one verdict (docs analogue of code-review-all)
docs-review-{style,structure,code-accuracy,terminology,links} read-only concerns, each loading review-conventions via MCP

The concerns derive from the last 2 months of docs PR feedback: de-claudeify
(style), mechanism-first / concept-ordering / diagram-type (structure), SDK
drift + pre-release (code-accuracy), root→object & barge-in vs interruption
(terminology), error-code searchability (links).

Removed

  • .claude/skills/write-docs/SKILL.md — content relocated to the AGENTS.md files.

@coderabbitai

coderabbitai Bot commented Jun 30, 2026

Copy link
Copy Markdown

Important

Review skipped

Auto reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

Run ID: 4aa6a1c7-1ec3-4ad3-8b58-6fc3dbb85f8e

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch skills/docs-authoring-orchestrator

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@mschristensen mschristensen force-pushed the skills/docs-authoring-orchestrator branch from c541579 to 95d78b9 Compare June 30, 2026 09:43
@mschristensen mschristensen marked this pull request as ready for review June 30, 2026 17:30
@mschristensen mschristensen requested a review from rainbowFi June 30, 2026 17:30
…docs

Express the docs-writing guidance as folder-level AGENTS.md so it auto-loads when
editing pages, instead of a skill-vendored rulebook:

- src/pages/docs/AGENTS.md — structure/IA principles, feature-page tiers,
  page-type templates, the API-reference standard, code-accuracy workflow, and
  verification checks.
- src/pages/docs/ai-transport/AGENTS.md — AI Transport positioning + terminology.

Removes the 506-line .claude/skills/write-docs/SKILL.md monolith; its content now
lives with the content it governs.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@mschristensen mschristensen force-pushed the skills/docs-authoring-orchestrator branch from 95d78b9 to 1da3837 Compare June 30, 2026 17:59
mschristensen and others added 3 commits June 30, 2026 19:00
Given an SDK release/tag, PR(s), commits, or local changes (resolved via the
shared code-resolve-changes skill over the Ably MCP), or a task, docs-plan writes
docs-plan.md of single-purpose page units. Plans; docs-write builds.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Drafts each page applying the folder AGENTS.md guidance, then runs the
docs-review-* concerns and iterates to PASS, coordinating subagents like
code-review-all. The write half of the write -> review loop.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
…erns

docs-review-all fans out five read-only concerns across subagents and synthesises
one verdict (the docs analogue of code-review-all): docs-review-style,
-structure, -code-accuracy, -terminology, -links. Each loads the shared
review-conventions contract via the Ably MCP and checks against the folder
AGENTS.md guidance. Concerns derive from the last 2 months of docs PR feedback.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@mschristensen mschristensen force-pushed the skills/docs-authoring-orchestrator branch from 1da3837 to 861ef3d Compare June 30, 2026 18:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

1 participant