documentation

Update repository documentation from git diffs and validate Rustdoc and Python docstrings.

1|Updated Sep 18, 2025
One-click install
npx skills add https://github.com/Startti/colmena --skill documentation-startti
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: documentation
Source: https://github.com/Startti/colmena/tree/main/.agent/skills/documentation
Command: npx skills add https://github.com/Startti/colmena --skill documentation-startti

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Ensures repository documentation stays consistent with code changes so users and contributors can understand features correctly without relying on outdated or missing information.

Core Features & Use Cases

  • Change-driven documentation updates: Detect what changed and update the most relevant docs accordingly.
  • Cross-language documentation hygiene: Keep Rustdoc (///) and Python docstrings in sync with implementation details.
  • Docs quality verification: Validate that diagrams, examples, links, and generated docs match the current code state.

Quick Start

Use the documentation skill when you modify code that affects behavior, public APIs, or docs, so the docs/ folder and in-code documentation reflect the latest implementation.

Frequently Asked Questions about documentation

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

FAQPage Schema
What does a git diff analysis cover when updating repository documentation?

A git diff analysis for updating repository documentation covers detecting changed features, APIs, or user-facing behaviors, then updating relevant Markdown docs, Rustdoc comments, and Python docstrings to maintain consistency across the project.

How do I keep Rust and Python documentation consistent with code changes?

To keep Rust and Python documentation consistent, analyze git diffs to detect behavioral or API changes, then update Rustdoc comments and Python docstrings alongside the `docs/` folder to match the latest implementation.

What is the best way to update repository docs after modifying public APIs?

The best way to update repository docs after modifying public APIs is to analyze the git diff, update affected Markdown files and in-code docstrings, and then validate the generated output using `cargo doc` with consistency checks for links and examples.

How do I verify Rustdoc examples and links match the current code state?

Verify Rustdoc examples and links match the current code state by running `cargo doc` and performing documentation consistency checks to ensure generated docs, examples, and organizational structure align with the latest repository implementation.

Does this documentation workflow support both Rust and Python projects?

Yes, this documentation workflow supports both Rust and Python projects by keeping Rustdoc and Python docstrings in sync with implementation details when features, APIs, or user-facing behaviors change in the repository.

When should I update technical documentation to avoid technical debt?

Update technical documentation to avoid technical debt whenever code modifications affect behavior, public APIs, or user-facing features, ensuring the `docs/` folder and in-code documentation accurately reflect the current implementation without outdated information.