skills.rest
arloliu
arloliuCOMMUNITY
Explore all skills by this author →
GitHub

doc-sync

Audit docs and public Godoc against the current API surface.

3|Updated Oct 26, 2025
Search Tags:#documentation#api#auditing#docs#godoc#doc-sync#code-drift
One-click install
npx skills add https://github.com/arloliu/parti --skill doc-sync-arloliu
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: doc-sync
Source: https://github.com/arloliu/parti/tree/main/.agents/skills/doc-sync
Command: npx skills add https://github.com/arloliu/parti --skill doc-sync-arloliu

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Docs and code often diverge; this skill audits docs/ README.md and public Godoc to align with the current API surface, catches stale symbols and options, and guides targeted corrections without rewriting prose.

Core Features & Use Cases

  • Audits docs/ README.md and public-package Godoc to reflect the current API, exported symbols, options, and behavioral contracts.
  • Flags discrepancies between code and documentation and applies precise, minimal fixes.
  • Scope includes docs/, README.md, and public-package Godoc across modules to ensure release-ready accuracy.

Quick Start

Run the doc-sync skill to audit docs/ and public Godoc, then apply targeted fixes to reflect the current API surface.

Frequently Asked Questions about doc-sync

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

FAQPage Schema
How do I audit Godoc and README to reflect the current API surface?▼

To audit Godoc and README for the current API surface, run the doc-sync skill to scan public-package comments and docs, flagging stale exported symbols and options. It applies targeted fixes to align documentation without rewriting prose.

What is code drift in API documentation and how do I flag stale symbols?▼

Code drift occurs when exported symbols and API options diverge from documentation. This skill detects code drift by validating frontmatter-defined names and descriptions against the repository's current API surface, flagging discrepancies for correction.

Does the doc-sync skill rewrite prose when updating public-package comments?▼

No, the doc-sync skill does not rewrite prose. It applies precise, minimal fixes to public-package Godoc and docs by validating frontmatter and flagging stale results, ensuring release-ready accuracy without altering existing narrative text.

How do I update docs for release readiness across multiple modules?▼

Update docs for release readiness by running the skill to audit docs and public Godoc across modules. It scopes changes to non-internal packages, validating that frontmatter-defined names and descriptions reflect the current API surface for library maintenance.

Can I use this skill to audit internal package comments?▼

No, you cannot use this skill to audit internal package comments. The scope is strictly limited to non-internal packages, targeting docs/, README.md, and public-package Godoc to ensure corrections align with the exported API surface.

Related Skills

Explore More Content & Communication Skills→
xiaolaixiaolai
6

lang-go

Detect exported identifiers in Go code and enforce godoc-compliant comments for public APIs.

Community
Intermediate
AllBeingsFutureAllBeingsFuture
9

allbeingsfuture/skills@changelog-generator

Generate user-friendly markdown changelogs from git commit history.

Community
Intermediate
dennisonbertramdennisonbertram
1

doc-generation

Generate Go documentation, OpenAPI specs, and README templates.

Community
Advanced
AJBcodingAJBcoding
4

moai-docs-linting

Lint Markdown documentation for formatting, broken references, and structural issues.

Community
Advanced