Skip to content

[Documentation] - Set up Docusaurus Documentation Site #3978

@rbessin

Description

@rbessin

Current Features

The FinishLine project has developer documentation stored as SKILL.md files in the .claude/skills/ directory structure.

Examples include:
.claude/skills/general-practices/backend-endpoints/SKILL.md
.claude/skills/general-practices/postman-api-testing/SKILL.md
.claude/skills/general-practices/query-args-and-transformers/SKILL.md
.claude/skills/general-practices/repository-overview/SKILL.md

These files are in markdown format with YAML frontmatter and are primarily used by Claude AI for context. Developers must navigate the file system to read documentation, which is less accessible than a proper documentation site.

Desired Additional Features

Create a Docusaurus-based documentation website that:

Transforms existing SKILL.md files into a searchable, navigable documentation site
Runs locally for developer access (npm run docs:dev)
Auto-generates sidebar navigation from the .claude/skills/ folder structure
Includes a build script that:

  • Copies SKILL.md files from .claude/skills/ to the Docusaurus docs folder
  • Transforms YAML frontmatter to Docusaurus-compatible format
  • Maintains single source of truth (SKILL.md files)

Provides clear setup and build instructions in README

Scope:
Set up Docusaurus in new docs-site/ folder
Build script automation
Local development environment only

Out of Scope (for this ticket):
Public deployment (requires leadership approval - separate future ticket)
Custom styling/theming
New documentation content
Interactive components

Acceptance Criteria:

  • Docusaurus runs locally with npm run docs:dev
  • All existing SKILL.md files appear in the site
  • Sidebar navigation auto-generated from folder structure
  • Build script transforms YAML frontmatter correctly
  • README includes setup and build instructions

Screenshots (as needed)

No response

Metadata

Metadata

Assignees

Labels

new featureNew feature or request

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions