document-code

Create and update MDX documentation for Syncpack commands, configuration, and status codes.

2.1k|72|Updated Aug 17, 2017

Search Tags:#workflow #documentation #mdx #document #content-management #site-generation #syncpack

Ready to run

npx skills add https://github.com/JamieMason/syncpack --skill document-code

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: document-code
Source: https://github.com/JamieMason/syncpack/tree/main/skills/document-code
Command: npx skills add https://github.com/JamieMason/syncpack --skill document-code

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Sync teams need accurate, up-to-date documentation for user-facing changes to the codebase, ensuring discoverability and consistency across the Syncpack site.

Core Features & Use Cases

Documentation scaffolding: Provides a standard workflow to add and update docs for commands, configuration, status codes, and version groups.
Linking and mapping: Ensures docs map to source code changes and link identifiers to site navigation.
Local validation: Guides testing the site locally to verify documentation renders correctly.

Quick Start

Create or update the documentation pages following the project's mapping guide and test locally with the site's dev server.

Frequently Asked Questions about document-code

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

FAQPage Schema

How do I add MDX documentation for new Syncpack commands and configuration?▼

To add Syncpack documentation, create or update MDX pages for commands, configuration, status codes, and version groups by following the site's content mapping guide and front matter standards. Ensure pages link identifiers to site navigation via global reference links.

What is the standard workflow for maintaining Syncpack user-facing documentation?▼

The standard documentation workflow involves scaffolding content for commands and configuration, mapping docs to source code changes, linking identifiers to site navigation, and testing locally with the dev server to verify MDX rendering.

How do I validate Syncpack MDX docs locally before publishing changes?▼

Validate Syncpack MDX documentation locally by running the site's dev server. This tests the rendering to verify that front matter standards, content mapping, and global reference links are correctly applied before publishing.

Does Syncpack documentation require alignment with site navigation and source code changes?▼

Yes, Syncpack documentation requires strict alignment with the site's content mapping and front matter standards. Pages must map to source code changes and link identifiers to site navigation using global reference links for discoverability.

What is the best way to structure Syncpack FAQ and status code MDX pages?▼

Structure Syncpack FAQ and status code MDX pages by following the project's content mapping guide. Apply the required front matter standards and use global reference links to connect the content to the existing site navigation structure.

When should I update Syncpack documentation pages for version groups?▼

Update Syncpack documentation pages for version groups whenever user-facing codebase changes occur. This ensures accurate, up-to-date documentation across the Syncpack site, maintaining discoverability and consistency for users.