docs

Name: docs
Availability: InStock
Author: Racci

Analyze code changes and update Markdown files in the docs/src directory.

18|1|Updated Jun 2, 2023

Search Tags:#project management #documentation #markdown #technical writing #code sync #nixos

Ready to run

npx skills add https://github.com/DaRacci/nix-config --skill docs-daracci

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: docs
Source: https://github.com/DaRacci/nix-config/tree/main/.opencode/skills/docs
Command: npx skills add https://github.com/DaRacci/nix-config --skill docs-daracci

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill ensures that your project's documentation remains accurate, up-to-date, and synchronized with code changes, making it easier for anyone to understand and maintain the system.

Core Features & Use Cases

Automated Documentation Updates: Creates or updates Markdown files in the docs/src directory based on code implementations.
Structure Maintenance: Ensures new documentation is registered in SUMMARY.md to maintain the book structure.
Use Case: After adding a new NixOS module for a service, use this Skill to automatically generate a new documentation file for it, including code examples and usage instructions, and update the table of contents.

Quick Start

Use the docs skill to create a new documentation file for the 'new-feature' module.

Frequently Asked Questions about docs

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

FAQPage Schema

How do I keep documentation in sync with code changes automatically?▼

To keep documentation in sync with code changes, this Skill analyzes your codebase to create or update Markdown files in the docs/src directory. It ensures your technical writing accurately reflects shared modules and system-wide configurations.

How do I maintain a Markdown book structure when adding new documentation files?▼

To maintain a Markdown book structure, you must update the SUMMARY.md file to register new content. This Skill automatically updates SUMMARY.md whenever it generates a new documentation file, ensuring your table of contents remains structured and navigable.

Can I generate NixOS module documentation automatically?▼

Yes, you can generate NixOS module documentation automatically by analyzing code implementations. This Skill creates new Markdown files with code examples and usage instructions for NixOS modules, then registers them in the documentation book structure.

What is the best way to document shared modules and system-wide configurations?▼

The best way to document shared modules and system-wide configurations is to use a tool that analyzes code directly. This approach adheres to specific naming conventions and conciseness, creating structured Markdown files that accurately reflect your system's configuration.

Does this documentation approach require any external dependencies?▼

No, this documentation approach does not require any external dependencies. It operates independently to analyze code changes and generate Markdown files, making it easy to integrate into your existing project management workflow.