Skip to content

docs: refresh reference section with category badges and dynamic index pages#69

Merged
marcusrbrown merged 14 commits into
mainfrom
docs/reference-section-refresh
Feb 14, 2026
Merged

docs: refresh reference section with category badges and dynamic index pages#69
marcusrbrown merged 14 commits into
mainfrom
docs/reference-section-refresh

Conversation

@marcusrbrown
Copy link
Copy Markdown
Owner

Summary

  • Sidebar badges: Replace redundant definition-type badges (Skill/Agent/Command) with meaningful category badges for agents only (Review/Research/Design/Workflow). Skills and commands no longer show badges.
  • Dynamic index pages: Reference index pages (index.mdx) are now dynamically generated by transform-content.ts from the same enumerated DefinitionEntry metadata used for individual pages, using Starlight CardGrid/LinkCard components. Agents grouped by category, commands split into Workflows/Utilities, skills as a flat grid.
  • Definition headers: Each reference page gets a header with category label (agents) and "View source" link to the GitHub source file.
  • Title normalization: Reference page titles converted to Title Case with acronym handling.

Changes

File Change
docs/scripts/transform-content.ts Core changes: generateIndexPage(), DefinitionEntry interface, helper functions, processDirectory returns entries, removes unused params
.gitignore Simplified to ignore entire reference/ directory (index pages are now generated)
docs/AGENTS.md Updated to reflect generated index pages, agent-only badges, correct line count
docs/src/styles/custom.css Added .definition-header and .definition-category styles
docs/src/content/docs/reference/*/index.mdx Removed from git tracking (now generated)

Verification

  • bun run typecheck — passes
  • bun run lint — passes
  • bun run docs:build — 55 pages, zero errors
  • Deterministic grep: 0 badges on skills/commands, 24 category badges on agents (12 Review, 5 Research, 3 Design, 4 Workflow)
  • Visual verification with agent-browser: CardGrid layouts render correctly, sidebar badges show categories

Note

This branch has 12 commits including intermediate steps. Consider squash merge.

Replace hardcoded index.mdx files with dynamic generation in
transform-content.ts. Index pages are now built from the same
DefinitionEntry metadata collected during processDirectory, using
Starlight CardGrid/LinkCard components.

- Add generateIndexPage() with type-aware grouping (agents by category,
  commands by workflows/utilities, skills flat)
- Remove unused definitionType param from transformFrontmatter
- Add helper functions: cleanDescription, escapeAttr, firstSentence,
  renderLinkCard, renderCardGrid
- Simplify .gitignore to ignore entire reference/ directory
- Remove index.mdx skip guard from clean step
- Update docs/AGENTS.md to reflect generated index pages
@marcusrbrown
Copy link
Copy Markdown
Owner Author

@fro-bot if the review is good then approve

@marcusrbrown
Copy link
Copy Markdown
Owner Author

@fro-bot approve the pr if everything looks good

@marcusrbrown marcusrbrown merged commit 5a0975c into main Feb 14, 2026
11 checks passed
@marcusrbrown marcusrbrown deleted the docs/reference-section-refresh branch February 14, 2026 01:05
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.

2 participants