docs-add

Scaffold MyST documentation pages and update toctree navigation entries.

27|1|Updated Feb 20, 2024
One-click install
npx skills add https://github.com/liquidz00/Patcher --skill docs-add
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: docs-add
Source: https://github.com/liquidz00/Patcher/tree/main/.claude/skills/docs-add
Command: npx skills add https://github.com/liquidz00/Patcher --skill docs-add

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill helps you add a new documentation page to the Patcher site without guessing the right section, page structure, or navigation update.

Core Features & Use Cases

  • Page Scaffolding: Creates a new MyST markdown page with the correct opening pattern for the target section.
  • Section Routing: Chooses the best docs section for topics such as getting started, guides, concepts, API, support, reference, or roadmap.
  • Toctree Wiring: Updates the relevant docs index so the new page appears in site navigation.
  • Voice Alignment: Applies Patcher's documentation voice rules from the start so the page reads consistently with the rest of the site.

Quick Start

Ask for a new Patcher docs page on your topic and specify the section if you already know where it belongs.

Frequently Asked Questions about docs-add

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

FAQPage Schema
How do I add a new documentation page to a MyST site and update the toctree?

To add a new documentation page, scaffold a MyST markdown file with the correct opening pattern, route it to the appropriate section, and wire it into the toctree index so it appears in site navigation.

What is the correct way to route a new docs page into the right section?

Section routing categorizes your topic into predefined areas like getting started, guides, concepts, API, support, reference, or roadmap to ensure the documentation page is placed in the correct location.

How do I generate a MyST page structure that matches existing documentation voice rules?

Generating a compliant MyST page structure involves applying the target site's voice alignment rules and using the predefined docs template to ensure the new page reads consistently with the rest of the site.

Can I scaffold documentation pages for any topic without manually editing the navigation index?

Yes, you can scaffold pages for any topic without manual navigation edits because the process automatically updates the relevant docs index and wires the target anchor into the toctree.

What happens if my new documentation page does not satisfy the docs template requirements?

If a page does not satisfy docs template requirements, it risks breaking the MyST page structure and failing toctree wiring, which prevents the page from appearing correctly in site navigation.