codemod-docs

Generate consistent Codemod documentation and Mintlify pages with required frontmatter and structure.

1.1k|81|Updated Jan 26, 2024
One-click install
npx skills add https://github.com/codemod/codemod --skill codemod-docs
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: codemod-docs
Source: https://github.com/codemod/codemod/tree/main/.agents/skills/codemod-docs
Command: npx skills add https://github.com/codemod/codemod --skill codemod-docs

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Codemod docs writing can be inconsistent across CLI, workflows, JSSG, and platform docs. This skill helps maintain consistent Codemod documentation and Mintlify-based pages across the project, ensuring clear structure and reliable guidance.

Core Features & Use Cases

  • Enforces task-oriented documentation including goals, prerequisites, steps, expected outcomes, verification, and troubleshooting.
  • Promotes second-person, active voice, current CLI references, and accurate package paths.
  • Updates docs/docs.json when pages are added, moved, renamed, or removed, and favors real, verifiable command snippets.

Quick Start

Create a new docs page following Mintlify rules and Codemod docs standards.

Frequently Asked Questions about codemod-docs

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

FAQPage Schema
How do I structure Codemod documentation to meet project standards?

Codemod documentation requires a task-oriented structure with goals, prerequisites, steps, expected outcomes, verification, and troubleshooting sections. It enforces frontmatter presence and Mintlify components to enhance navigation and readability.

What's the best way to write Mintlify docs for Codemod CLI and workflows?

Writing Mintlify docs for Codemod CLI and workflows requires using current CLI references, accurate package paths, and real command snippets. Documentation should use second-person active voice and explicit section structures.

How do I update docs.json when adding or renaming Codemod documentation pages?

Updating docs.json when Codemod documentation pages are added, moved, renamed, or removed requires modifying the navigation configuration. The process ensures Mintlify page routing and sidebar navigation remain accurate and verifiable.

Does Codemod documentation require frontmatter for Mintlify pages?

Codemod documentation enforces frontmatter presence for all Mintlify pages to meet project standards. This metadata ensures proper page rendering, navigation grouping, and SEO indexing across CLI, workflows, JSSG, and platform docs.

Can I use Mintlify components to improve Codemod docs readability?

Mintlify components are required in Codemod docs to enhance navigation and readability. The documentation standards favor real command snippets and structured sections that utilize these components for troubleshooting and verification guidance.

What writing style should I use for Codemod platform documentation?

Codemod platform documentation should use second-person active voice, current CLI references, and accurate package paths. This writing style ensures clear, verifiable guidance that aligns with the project's task-oriented documentation standards.