docs: add resources section + template more engine and ops pages#42
Open
abdout wants to merge 3 commits into
Open
docs: add resources section + template more engine and ops pages#42abdout wants to merge 3 commits into
abdout wants to merge 3 commits into
Conversation
Four new resources pages fill in the gaps that shadcn-style docs have but kun's flat structure was missing. - resources/faq.mdx — Accordion-grouped Q&A across getting started, daily use, troubleshooting, and engine internals - resources/changelog.mdx — release notes stub with current unreleased section pointing at PRs #39 and #40 of this refresh - resources/theming.mdx — token reference for the OKLch system, dark mode toggle, RTL logical properties, and custom-token recipe - resources/cli.mdx — flag reference for bootstrap, doctor, maintain, sync-repos, secrets, install scripts (PowerShell and bash) - resources/meta.json updated to declare new page order Why: docs site felt thin compared to shadcn equivalents — FAQ surfaces common stuck-points, theming guides override authoring, and CLI reference cuts a 40-line "what does this flag do" loop. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Apply canonical page template to three more engine pages. - mcp.mdx — hero blockquote, installation moved to top, usage section, reference tables grouped by category, role-specific configs preserved, examples added, Related cross-links - claude-md.mdx — hero, installation, usage with "what's loaded" recipe, three-layer reference, do/avoid lists preserved, examples added - keywords.mdx — Related section added (page keeps its Harry Potter voice and Spellbook-driven layout) Why: parity with the agents/skills/commands/captain rewrites in #40 so all engine pages share the same shape (hero → preview/installation → usage → reference → examples → related). Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Apply canonical page template to three more operations pages. - cowork.mdx — hero blockquote, shared-state and handoff sections, per-operator examples preserved, Related cross-links - team.mdx — hero, role descriptions, installation block, reference tables (MCP map, install layers), per-role daily-workflow examples, health-monitoring kept, Related cross-links - dispatch.mdx — hero, channels table, usage block, reference (priority levels + session-start protocol), how-it-works AppleScript snippet, dispatch-vs-issues block, examples added, Related cross-links Why: parity with captain (already templated in #40) so the operations section reads consistently. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
This was referenced May 18, 2026
abdout
changed the base branch from
docs/shadcn-page-templates
to
docs/shadcn-page-templates-clean
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Phase 3 of the shadcn-style docs refresh. Stacked on top of #40.
Adds a complete Resources section (FAQ, changelog, theming, CLI) that was missing entirely, and applies the canonical page template to six more pages across Engine and Operations.
This PR targets
docs/shadcn-page-templates(Phase 2) and should be merged after #40 lands. Rebase onto main after that.Changes
New resources pages (4)
resources/faq.mdx—<Accordion>-grouped Q&A across getting started, daily use, troubleshooting, and engine internalsresources/changelog.mdx— release notes stub with current "Unreleased" section pointing at PRs docs: restructure to shadcn-style hierarchical IA #39 and docs: adopt shadcn page template on 5 flagship pages #40 of this refreshresources/theming.mdx— token reference for the OKLch system, dark mode toggle, RTL logical-property table, custom-token reciperesources/cli.mdx— flag reference forbootstrap,doctor,maintain,sync-repos,secrets,installscripts (both PowerShell and bash variants)resources/meta.jsonupdated to declare new page orderEngine pages templated (3)
engine/mcp.mdx— hero, installation moved to top, usage section, reference tables grouped by category, role configs preserved, examples, Relatedengine/claude-md.mdx— hero, installation, usage with "what's loaded" recipe, three-layer reference, do/avoid lists, examplesengine/keywords.mdx— Related section added (Spellbook-driven page keeps its Harry-Potter voice)Operations pages templated (3)
operations/cowork.mdx— hero, shared-state table, handoff workflow, per-operator examples, Relatedoperations/team.mdx— hero, role descriptions, installation block, MCP/install reference tables, per-role examples, health monitoring, Relatedoperations/dispatch.mdx— hero, channels table, usage, priority/protocol reference, AppleScript internals, dispatch-vs-issues block, examples, RelatedTest plan
pnpm docs:checkpasses (40 files / 40 slugs / 0 broken links)next buildsucceeds — all paths generatedOut of scope
context,voice,credentials,connectors,apps,issue) stay at Phase 1 baseline — functional but lighter shape, deferred to Phase 4🤖 Generated with Claude Code