documentation

Standardize sfdx-hardis command documentation with YAML frontmatter and MkDocs structure.

368|98|Updated Jan 25, 2021

Search Tags:#documentation #markdown #yaml #commands #frontmatter #mkdocs

Ready to run

npx skills add https://github.com/hardisgroupcom/sfdx-hardis --skill documentation-hardisgroupcom

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: documentation
Source: https://github.com/hardisgroupcom/sfdx-hardis/tree/main/.claude/skills/documentation
Command: npx skills add https://github.com/hardisgroupcom/sfdx-hardis --skill documentation-hardisgroupcom

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Documentation standards and templates ensure consistent and high-quality command docs for sfdx-hardis, reducing ambiguity and onboarding time.

Core Features & Use Cases

Enforces a consistent YAML frontmatter with required fields (name, description) for all commands.
Provides structured sections like Command Behavior and Technical explanations to standardize content.
Supports MkDocs site generation and future automation for documentation build workflows.

Quick Start

Describe a new command using the template in this skill to ensure a standardized frontmatter and documentation body.

Frequently Asked Questions about documentation

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

FAQPage Schema

How do I standardize CLI documentation for sfdx-hardis commands?▼

To standardize CLI documentation, use a template enforcing YAML frontmatter with required name and description fields, plus structured Markdown sections like Command Behavior and Technical explanations for consistency.

What YAML frontmatter is required for MkDocs command documentation?▼

Required YAML frontmatter for MkDocs command documentation must include a name and description field to ensure consistent metadata parsing and site generation across all commands.

How does MkDocs site generation work with structured Markdown documentation?▼

MkDocs site generation works by parsing standardized Markdown files with YAML frontmatter, using the defined Command Behavior and Technical explanation sections to build a consistent documentation site.

Does sfdx-hardis documentation require specific Markdown section headers?▼

Yes, sfdx-hardis documentation requires specific bolded Markdown section headers, including Command Behavior and Technical explanations, to standardize content structure and reduce onboarding ambiguity.

Can I use this documentation template for automating CLI command build workflows?▼

Yes, the documentation template supports MkDocs build workflows and future automation by providing a standardized Markdown structure that ensures consistent command documentation generation.

What is the best way to format technical explanations in command documentation?▼

The best way to format technical explanations is using the standardized Markdown template with bolded section headers, ensuring clarity and consistency across all sfdx-hardis command documentation.