Skip to content

docs: adopt shadcn page template on 5 flagship pages#40

Closed
abdout wants to merge 2 commits into
docs/shadcn-ia-restructurefrom
docs/shadcn-page-templates
Closed

docs: adopt shadcn page template on 5 flagship pages#40
abdout wants to merge 2 commits into
docs/shadcn-ia-restructurefrom
docs/shadcn-page-templates

Conversation

@abdout
Copy link
Copy Markdown
Contributor

@abdout abdout commented May 18, 2026

Summary

Phase 2 of the shadcn-style docs refresh. Stacked on top of #39.

Rewrites the five highest-impact pages to match shadcn/ui's canonical page structure: hero → preview → installation → usage → reference → examples → related. Adds the missing <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: registers LinkedCard and LinkedCards for MDX.
  • content/docs/installation/index.mdx: title bumped from "Onboarding" to "Installation" to match the section. <LinkedCards> path picker at the top, <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 block 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; full command catalogue.
  • content/docs/operations/captain.mdx: <FlowChart> of the Mon/Wed/Fri rhythm; decision matrix + scenario examples + financial dashboard preserved.

Template structure (now canonical for kun docs)

Frontmatter (title, description)
> Hero blockquote — one-sentence punch
## Preview — visualization (FlowChart, BlockDiagram, BuildingBlocks, LinkedCards)
## Installation — when applicable
## Usage — single-paste example
## Reference — tables
## Examples — multiple scenarios
## Related — cross-links

Test plan

  • next build succeeds — 37 docs paths generated (including the orphan auto-sync.mdx from a sibling branch)
  • All 5 rewritten pages render without MDX errors
  • After merge: visual check of each page in dev — preview blocks render, LinkedCards are clickable, RTL works
  • After merge: TOC right-rail shows new section structure cleanly

Out of scope

  • Phase 3 (installation per-OS split, FAQ, changelog, theming, CLI ref)
  • Phase 4 (hover anchors, badges, Cmd+K search, mobile sidebar)
  • Untracked content/docs/auto-sync.mdx and .claude/scripts/auto-sync-* files belong to a sibling branch and are not included here

🤖 Generated with Claude Code

abdout and others added 2 commits May 18, 2026 07:26
Adds a background service that watches every databayt repo at ~/<name>
and keeps it in sync with origin without manual intervention. Local
commits push within ~2s; remote commits pull within ~60s.

The design implements the user-chosen "real-time + polling" model:

  Push side (real-time):
    FileSystemWatcher (Windows) / fswatch (macOS) / inotifywait (Linux)
    on .git/refs/heads. On change → 2s debounce → git push.

  Pull side (polling):
    Every 60s per repo: git fetch + git pull --rebase. Skipped when
    the working tree is dirty (in-flight work is sacred). On conflict,
    git rebase --abort is called and the failure logged.

  Per-repo isolation:
    One repo failing (auth, no upstream, force-push) doesn't stop the
    others — each iteration of the loop catches its own exceptions.

Files:

  .claude/scripts/auto-sync.ps1            193 LOC — Windows runtime
  .claude/scripts/auto-sync.sh             171 LOC — macOS/Linux runtime
  .claude/scripts/auto-sync-install.ps1    110 LOC — Task Scheduler register
  .claude/scripts/auto-sync-install.sh     143 LOC — launchd / systemd-user
  content/docs/auto-sync.mdx               full user-facing doc page

Install (user-scoped, no admin/sudo):

  # Windows
  & "$env:USERPROFILE\.claude\scripts\auto-sync-install.ps1" -Install

  # macOS / Linux
  ~/.claude/scripts/auto-sync-install.sh --install

Service registration:

  Windows: Task Scheduler 'At logon' trigger, restart on failure 3×,
           allowed on battery, no execution time limit, runs hidden.
  macOS:   launchd LaunchAgent with KeepAlive=true + RunAtLoad=true.
  Linux:   systemd --user service with Restart=always + RestartSec=10,
           WantedBy=default.target.

Logs at ~/.claude/logs/auto-sync-<date>.log with structured levels
(INFO / PUSH / PULL / WARN / ERROR) per repo per event.

Reads ~/.claude/memory/repositories.json for the repo list; falls
back to the canonical 11-repo set if absent. Works with both the
old ~/oss/<name> layout and the new ~/<name> layout (PR #38).

Both scripts validated: `bash -n` clean, PowerShell parse clean.

Refs #28

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
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>
@vercel
Copy link
Copy Markdown

vercel Bot commented May 18, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
kun Ready Ready Preview, Comment May 18, 2026 5:28am

abdout added a commit that referenced this pull request May 18, 2026
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>
abdout added a commit that referenced this pull request May 18, 2026
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>
@abdout
Copy link
Copy Markdown
Contributor Author

abdout commented May 18, 2026

Closing in favor of a clean rebuild without the auto-sync commit that leaked into Phase 2 when the parallel feat/auto-sync-service branch was active. Replaced by #44 — same Phase 2 content, cherry-picked cleanly onto Phase 1 (#39).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant