skills.rest
carrotwaxr
carrotwaxrCOMMUNITY
Explore all skills by this author →
GitHub

updating-docs

Enforce MkDocs structure and generate TypeScript API reference documentation.

37|6|Updated Oct 10, 2025
Search Tags:#documentation#docs#regenerate#api-reference#style-guide#mkdocs#mkdocs-material
One-click install
npx skills add https://github.com/carrotwaxr/peek-stash-browser --skill updating-docs
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: updating-docs
Source: https://github.com/carrotwaxr/peek-stash-browser/tree/main/.claude/skills/updating-docs
Command: npx skills add https://github.com/carrotwaxr/peek-stash-browser --skill updating-docs

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Provides a consistent, repeatable process for creating and updating project documentation for peek-stash-browser, preventing broken links, inconsistent styles, and stale API references.

Core Features & Use Cases

  • Guides authors to use MkDocs with the Material theme and to place content in the correct docs/ subdirectories (getting-started, user-guide, development, reference, plans).
  • Documents the automated API reference generation from TypeScript via server/scripts/generate-api-docs.ts and the CI triggers that rebuild the site on relevant source changes.
  • Covers redirects, local preview, design and implementation plan templates, and conventions for page structure, admonitions, and troubleshooting; useful when adding features, updating installation steps, or moving pages.

Quick Start

Update the getting-started/installation.md page to document Docker and JWT setup, then regenerate the API reference by running the server scripts to rebuild docs.

Frequently Asked Questions about updating-docs

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

FAQPage Schema
How do I generate API reference docs from TypeScript for my MkDocs site?▼

Run server/scripts/generate-api-docs.ts to extract TypeScript signatures and output Markdown files into the MkDocs reference directory, ensuring your API documentation stays synchronized with the latest codebase changes.

What is the correct directory structure for organizing MkDocs Material documentation?▼

Place content into dedicated docs/ subdirectories including getting-started, user-guide, development, reference, and plans to maintain a consistent MkDocs Material site structure and ensure reliable navigation across the project.

How do I configure redirects when moving pages in an MkDocs project?▼

Configure redirects within mkdocs.yml to map old URLs to new page locations when moving content, preventing broken links and preserving search engine ranking during site structure updates.

Does MkDocs Material support CI-triggered builds for documentation updates?▼

Yes, CI pipelines can automatically rebuild and deploy the MkDocs site when relevant source files change, ensuring the published documentation always reflects the latest repository state without manual intervention.

What conventions should I follow when writing user guides and design plans in MkDocs?▼

Follow established page structure, admonition, and troubleshooting conventions when writing user guides and design plans in MkDocs, using provided templates to enforce style consistency and improve content discoverability.

Why are my documentation links broken after moving Markdown files in MkDocs?▼

Broken links occur when pages are moved without updating mkdocs.yml redirects to map old paths to new locations, causing 404 errors; you must configure redirect rules to maintain site integrity during restructuring.

Related Skills

Explore More Content & Communication Skills→
carrotwaxrcarrotwaxr
37

visual-style

Enforce consistent visual styling for Peek UI components with CSS custom properties and Tailwind patterns.

Community
Intermediate
parkwoocheolparkwoocheol
91

composewebview-documentation

No, I need to provide accurate JSON for backend_api_call.incorrectly formatted input.

Community
Intermediate
kcenonkcenon
2

documentation

Enforce documentation standards for READMEs, API docs, and code comments.

Community
Basic
windyskywindysky

moai-docs-generation

Generate documentation patterns from code for Sphinx, MkDocs, TypeDoc, and Nextra.

Community
Advanced