skills.rest
matthiasn
matthiasnCOMMUNITY
Explore all skills by this author →
Website𝕏@matthiasnehlsenGitHub

maintain-docusaurus-manual

Maintains localized Docusaurus manuals with parity audits, screenshots, and build validation.

1.2k|117|Updated Mar 16, 2016
Search Tags:#audit#Markdown#docusaurus#Technical Writing#Documentation#Localization#I18n
One-click install
npx skills add https://github.com/matthiasn/lotti --skill maintain-docusaurus-manual
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: maintain-docusaurus-manual
Source: https://github.com/matthiasn/lotti/tree/main/.claude/skills/maintain-docusaurus-manual
Command: npx skills add https://github.com/matthiasn/lotti --skill maintain-docusaurus-manual

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve?

Keeping a multilingual Docusaurus product manual aligned with a changing application is error-prone: translated pages drift out of sync, screenshots go stale, navigation misses new pages, and a passing build does not prove the prose is accurate. This Skill provides a disciplined workflow for updating, translating, auditing, and validating a Docusaurus manual so documentation stays consistent with the actual product.

Core Features & Use Cases

  • Locale Parity Auditing: A bundled Python script compares canonical docs trees against i18n locale trees, reporting missing, extra, and identical-body pages per locale.
  • Structured Update Workflow: Step-by-step guidance for verifying product behavior from source code, updating canonical pages, preserving frontmatter and MDX components, and propagating changes to every published locale.
  • Screenshot and Validation Discipline: Rules for using deterministic screenshot registries, plus a staged validation ladder from parity audits through production builds and rendered-page review.
  • Use Case: After shipping a new feature, use this Skill to document it in the canonical locale, update all translated MDX trees, register new screenshots, run the parity audit, and validate the production build before publishing.

Quick Start

Use the maintain-docusaurus-manual skill to document the latest feature change, update all locales, and validate the Docusaurus site before release.

Frequently Asked Questions about maintain-docusaurus-manual

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

FAQPage Schema
How do I audit Docusaurus i18n locale parity?▼

Run the bundled audit_docusaurus_locales.py script with --site-root pointing at your Docusaurus site. It compares the canonical docs tree against each i18n locale tree and reports missing, extra, and identical-body pages per locale.

How do I keep translated Docusaurus docs in sync with the source?▼

Update the canonical page first, then translate meaning rather than sentence shape into every published locale while preserving frontmatter slugs, MDX imports, and component props. Finish by running the parity audit to catch missing or extra pages.

Does the locale audit script require external Python packages?▼

No, the audit script uses only the Python standard library (argparse and pathlib). It requires Python 3 and standard Docusaurus docs and i18n directory layouts, with configurable directory names via flags.

Why does a successful Docusaurus build not prove documentation accuracy?▼

A build only verifies that pages compile and links resolve, not that prose matches actual product behavior. The Skill requires verifying behavior from source code and reviewing rendered pages at representative widths in every changed locale.

When should I not use this manual maintenance workflow?▼

For a one-off application screenshot, use the repository's dedicated screenshot skill instead of extending the manual pipeline. The Skill also defers to repository-declared conventions rather than assuming default Docusaurus paths.

Related Skills

Explore More Software Engineering Skills→
ktolonenktolonen
30

fix-user-language

Correct spelling, terminology, and translation inconsistencies in Ultiorganizer user-facing strings.

Community
Basic
imsanghaarimsanghaar

docusaurus-deployer

Automate Docusaurus site deployment to GitHub Pages via GitHub Actions.

Community
Advanced
Bad-RobotsBad-Robots

browser-automation

Validate web applications in real browsers and capture behavior evidence.

Official
Advanced
IsNoobgrammerIsNoobgrammer
4

documenter

Generate structured technical documentation and configure Docusaurus, MkDocs, or VitePress sites.

Community
Advanced