skills.rest
macalbert
macalbertCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

doc-sync

Audits and synchronizes documentation across website, READMEs, and docs directories to detect drift.

138|5|Updated Sep 19, 2024
Search Tags:#documentation#drift detection#audit#sdk#readme#release#i18n
One-click install
npx skills add https://github.com/macalbert/envilder --skill doc-sync-macalbert
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: doc-sync
Source: https://github.com/macalbert/envilder/tree/main/.github/skills/doc-sync
Command: npx skills add https://github.com/macalbert/envilder --skill doc-sync-macalbert

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Documentation drifts out of sync when features, CLI flags, SDK APIs, or GitHub Action inputs change but the website, READMEs, and docs are not updated together. This Skill audits every documentation surface against the actual source code and reports inconsistencies before they reach users. ## Core Features & Use Cases - Cross-surface auditing: Compares website content (DocsContent.astro, i18n strings), root and GitHub Action READMEs, CLI docs, SDK READMEs, changelogs, and ROADMAP against authoritative sources like Cli.ts and action.yml. - Structured drift reports: Produces a severity-ranked table of mismatches covering code examples, CLI flags, GHA inputs, SDK methods, install commands, provider naming, broken links, and i18n completeness across en, ca, and es locales. - Cross-reference matrix: Maps each code change (new CLI flag, GHA input, SDK API, provider, or map-file format) to every documentation surface that must be updated. - Use Case: After adding a new --profile flag to the CLI, run a doc-sync audit to find every README, website section, and i18n string that still documents the old flag set, then apply and validate the fixes. ## Quick Start Ask the assistant to run a doc-sync audit on the CLI feature area and report any documentation drift against the current source code.

Frequently Asked Questions about doc-sync

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

FAQPage Schema
How do I keep documentation in sync across READMEs and a website?▼

Run a doc-sync audit that compares each documentation surface against authoritative sources like the CLI entry point and action.yml. It produces a severity-ranked drift report listing every file and issue, then guides applying and validating fixes.

How to detect outdated code examples in documentation?▼

The audit checks that documented code examples match the current API by verifying CLI flags against Cli.ts, GHA inputs against action.yml, and SDK methods against the SDK source code. Mismatches are reported with file location and severity.

What documentation surfaces does a doc-sync audit cover?▼

It covers website docs and i18n strings (en, ca, es), the root README, GitHub Action README, CLI command docs, SDK READMEs for dotnet, python, and typescript, SDK examples, per-component changelogs, and the ROADMAP file.

Does doc-sync check i18n translation consistency?▼

Yes, it verifies that all three locales (en, ca, es) have matching i18n keys. When a fix changes i18n strings, the procedure requires updating all three locales and validating the website build.

When should I run a documentation drift audit?▼

Run it after adding or changing a feature, CLI flag, or SDK capability, after updating website content, before a release, or when a code review flags outdated documentation. A full audit covers all surfaces at once.

Related Skills

Explore More Software Engineering Skills→
juxtjuxt
10

weed-docs

Audit user-facing documentation for drift from code changes.

Official
Intermediate
outfitter-devoutfitter-dev
28

claude-plugin-distribution

Package and distribute Claude Code plugins with versioning and GitHub releases.

Official
Intermediate
parcadeiparcadei
3.9k

qlty-during-development

Runs QLTY lint and format checks on code after significant edits.

Community
Basic
JEO-tech-aiJEO-tech-ai
8

api-documentation

Generate OpenAPI/Swagger-compatible API documentation from definitions, schemas, and annotations.

Community
Advanced