man-docs

Automate creation, splitting, and updating of man page YAML specs for carapace-bin completers.

1.9k|133|Updated Apr 20, 2020
One-click install
npx skills add https://github.com/carapace-sh/carapace-bin --skill man-docs
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: man-docs
Source: https://github.com/carapace-sh/carapace-bin/tree/main/skills/man-docs
Command: npx skills add https://github.com/carapace-sh/carapace-bin --skill man-docs

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires carapace-man, python, and includes scripts (resource) and references (resource) components.

What problem does it solve?

Manages and automates the documentation process for man pages in carapace-bin, streamlining the creation and updating of YAML specs for completers.

Core Features & Use Cases

  • Documentation Workflow Automation: Automates the generation, splitting, and updating of YAML documentation specs.
  • Documentation Standards Enforcement: Ensures adherence to documentation standards for commands and flags.
  • Quick Documentation Updates: Facilitates quick updates and corrections of existing documentation.
  • Use Case: For a developer looking to add or update documentation for a carapace-bin completer, this skill automates the process of creating and updating YAML man page specs.

Quick Start

Run the command 'carapace-man update <completer>' to update the documentation for a specific completer.

Frequently Asked Questions about man-docs

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

FAQPage Schema
How do I automate man page documentation for carapace-bin completers?

Automating man page documentation for carapace-bin completers involves generating, splitting, and updating YAML specs using the carapace-man update command to streamline the workflow from source spec to final output.

How do I update YAML documentation specs for an existing carapace completer?

To update YAML documentation specs for an existing carapace completer, run the command 'carapace-man update <completer>' to quickly apply corrections and regenerate the man page documentation for the specified command.

Do I need Python to generate carapace-bin man page documentation?

Yes, you need Python installed to use this documentation workflow, along with the carapace-man tool, as both are required dependencies for generating and splitting the YAML specs for completers.

What is the best way to enforce documentation standards for carapace completers?

Enforcing documentation standards for carapace completers is handled by automating the creation of YAML man page specs, which ensures consistent adherence to documentation rules for commands and flags across the project.

Can I split a large YAML man page spec into separate documentation files?

Yes, the documentation workflow automation process handles the splitting of YAML documentation specs, allowing you to divide large man page sources into organized, manageable output files for carapace-bin completers.