docs: adopt shadcn page template on 5 flagship pages#44
Open
abdout wants to merge 1 commit into
Open
Conversation
Rewrite installation/index, engine/agents/index, engine/skills, engine/commands, and operations/captain to match shadcn/ui's canonical page structure: hero blockquote → preview visualization → installation → usage → reference tables → examples → related. Why: shadcn-style page templates make docs scannable. A reader can land on any page and orient via a one-sentence hero, see the shape via a preview block, then drop into reference or examples without hunting for structure. The 5 chosen pages cover the highest-traffic entry points for new contributors and existing operators. - Add LinkedCards / LinkedCard primitives at src/components/docs/linked-card.tsx — grid of clickable cards with hover state, RTL-flipped chevron, semantic tokens only - Register LinkedCard + LinkedCards in src/mdx-components.tsx - installation/index: LinkedCards path picker + Tabs (Cowork vs Manual) + Steps, content preserved from the existing onboarding flow - engine/agents/index: BuildingBlocks tier preview + reorganized reference tables with installation moved to the top - engine/skills: installation + usage examples + reference tables grouped by category (workflow / creation / quality / utility / etc.) - engine/commands: full catalogue including pipeline + sweeps + intel sections that were previously missing - operations/captain: FlowChart of the Mon/Wed/Fri rhythm + decision matrix + scenario examples + financial dashboard 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 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 2 of the shadcn-style docs refresh, re-opened from a clean branch after #40 was contaminated by the parallel auto-sync work. Stacked on top of #39.
Adopts the canonical shadcn page template (hero → preview → installation → usage → reference → examples → related) on the five highest-impact pages, and adds the
<LinkedCards>primitive that path-picker grids depend on.This PR targets
docs/shadcn-ia-restructure(Phase 1) and should be merged after #39 lands. Rebase onto main after that.Changes
src/components/docs/linked-card.tsx(new):<LinkedCards>grid container +<LinkedCard>item. Hover state, RTL-flipped chevron, semantic tokens only (bg-card,bg-accent).src/mdx-components.tsx: registersLinkedCardandLinkedCardsfor MDX.content/docs/installation/index.mdx: title bumped from "Onboarding" to "Installation".<LinkedCards>path picker,<Tabs>for Cowork vs Manual,<Steps>for the 3-step Cowork flow.content/docs/engine/agents/index.mdx:<BuildingBlocks>tier preview replaces the ASCII art; installation moved up; reference tables reorganized; routing examples expanded.content/docs/engine/skills.mdx: installation + usage at the top; categorized reference tables; examples section added.content/docs/engine/commands.mdx: adds pipeline, coverage sweeps, intelligence sections that were missing.content/docs/operations/captain.mdx:<FlowChart>of the Mon/Wed/Fri rhythm; decision matrix + scenario examples + financial dashboard preserved.Why a fresh branch
The original Phase 2 branch picked up an auto-sync commit (
52315a7) from a parallelfeat/auto-sync-servicebranch that was being worked on simultaneously. The leak ended up inside #40's diff and could not be force-pushed away (harness denied). This branch is the same Phase 2 work cherry-picked cleanly onto Phase 1 — diff matches what #40 was supposed to be.Test plan
pnpm docs:checkcleannext buildsucceeds — 37 docs paths generatedStack
The Phase 3 and Phase 4 PRs already branch from this clean chain, so they don't need re-targeting —
#42isdocs/shadcn-new-sectionswhich contains commit3a99d36(Phase 2 cherry-pick), then Phase 3 commits, identical to what this branch ships.🤖 Generated with Claude Code