Skip to content

Context

docs/index.md was written for the original OpenAPI-based plugin. It references OpenAPI/Swagger, mentions "one Markdown page per endpoint", tag-grouped sidebars by OpenAPI tag, and links to /api/ — all of which no longer apply. The plugin now renders an OpenSpec project folder (openspec/specs/, openspec/changes/) into VitePress pages.

Goals / Non-Goals

Goals:

  • Replace all OpenAPI references with accurate OpenSpec descriptions
  • Make the hero section immediately communicate what the plugin does
  • Link the hero CTA to the generated OpenSpec docs section (/openspec/)

Non-Goals:

  • Writing a full user guide or getting-started tutorial
  • Documenting the plugin API (function signatures, options)
  • Changing any plugin code or configuration

Decisions

Single file change only (docs/index.md) The rest of the docs site is auto-generated by the plugin itself from openspec/. Only the landing page is manually authored and needs updating.

Keep VitePress layout: home format The existing home layout with hero + features works well. Reuse it; just swap the content.

Feature cards: describe the three main capabilities

  1. Spec pages — renders openspec/specs/ as canonical capability pages
  2. Change pages — renders openspec/changes/ with proposal/design/tasks artifacts
  3. Navigation helpers — openspecNav() + generateOpenSpecSidebar() for themeConfig

Risks / Trade-offs

  • None significant — this is a pure content update with no code changes.