docs

Generate a Docusaurus documentation site from ADRs and OpenSpec specs.

30|2|Updated Feb 13, 2026
One-click install
npx skills add https://github.com/joestump/claude-plugin-design --skill docs-joestump
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: docs
Source: https://github.com/joestump/claude-plugin-design/tree/main/skills/docs
Command: npx skills add https://github.com/joestump/claude-plugin-design --skill docs-joestump

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This skill automates generation and maintenance of a Docusaurus documentation site from ADRs and OpenSpec specs, eliminating manual transforms, cross-references, and upgrade bookkeeping.

Core Features & Use Cases

  • Scaffold or integrate a standalone docs-site or a build-time plugin into an existing Docusaurus project.
  • Transforms and components convert ADRs and specs to MDX with RFC 2119 highlighting, requirement boxes, badges, cross-reference links, and auto-generated sidebars.
  • Upgrade tracking and safety creates and maintains a .design-docs.json manifest with sha256 checksums to manage template upgrades while preserving user customizations.
  • Use Case: Publish a living architecture docs site from docs/adrs and docs/openspec/specs or add a non-destructive sync plugin to a corporate Docusaurus site.

Quick Start

Run the docs skill to scaffold or integrate a Docusaurus docs site from your repository's ADRs and OpenSpec specs.

Frequently Asked Questions about docs

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I generate a Docusaurus site from ADRs and OpenSpec specs?

To generate a Docusaurus site from ADRs and OpenSpec specs, run the docs skill to trigger transform scripts that convert your markdown into MDX with auto-generated sidebars, requirement boxes, and cross-reference links, writing a .design-docs.json manifest for tracking.

Can I add architecture documentation to an existing Docusaurus project without overwriting customizations?

You can integrate architecture documentation into an existing Docusaurus project non-destructively. The skill uses a .design-docs.json manifest with sha256 checksums to manage template upgrades while preserving your site customizations during sync workflows.

What is the required directory structure for converting ADRs and OpenSpec specs to MDX?

The required directory structure for converting ADRs and OpenSpec specs to MDX expects ADRs stored in docs/adrs and OpenSpec specs stored in docs/openspec/specs within your repository. The skill detects these paths to automate the transformation process.

Do I need Node.js to scaffold a Docusaurus documentation site from ADRs?

Yes, you need Node.js installed to scaffold a Docusaurus documentation site from ADRs. The skill performs pre-flight checks for Node.js before detecting or copying templates and running transform scripts to produce the MDX output.

How does upgrade tracking work when maintaining a generated Docusaurus site?

Upgrade tracking for a generated Docusaurus site works by creating and maintaining a .design-docs.json manifest with sha256 checksums. This allows the skill to detect template changes during upgrades while safely preserving your local customizations.

What formatting features are applied when transforming OpenSpec specs to MDX?

When transforming OpenSpec specs to MDX, the skill applies formatting features including RFC 2119 highlighting, requirement boxes, status badges, cross-reference links, and auto-generated sidebars to produce a living architecture documentation site.