genesis-tools:living-docs

Manage codebase documentation with minimal token-efficient doc chunks.

7|2|Updated Apr 16, 2025
One-click install
npx skills add https://github.com/genesiscz/GenesisTools --skill genesis-tools-living-docs
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: genesis-tools:living-docs
Source: https://github.com/genesiscz/GenesisTools/tree/main/plugins/genesis-tools/skills/living-docs
Command: npx skills add https://github.com/genesiscz/GenesisTools --skill genesis-tools-living-docs

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill automates the creation, validation, and refinement of codebase documentation, ensuring it remains minimal, accurate, and useful as a search index rather than a textbook.

Core Features & Use Cases

  • Automated Doc Generation: Scans code to create minimal doc chunks for reusable components, utilities, and complex flows.
  • Drift Detection: Validates existing documentation against code changes, flagging inconsistencies.
  • Optimization: Refines documentation for clarity, token efficiency, and better AI trigger activation.
  • Use Case: When you update a shared UI component, this Skill can automatically check if its documentation is still accurate and update any broken references, ensuring developers always have correct API information.

Quick Start

Use the living-docs skill to validate the documentation against the current codebase.

Frequently Asked Questions about genesis-tools:living-docs

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

FAQPage Schema
How do I automate codebase documentation to keep it minimal and accurate?

Automated codebase documentation uses a self-maintaining system to scan code, generate minimal doc chunks, and validate them against changes. This ensures documentation remains an accurate, token-efficient search index rather than a static textbook.

What is documentation drift and how do I detect it in my codebase?

Documentation drift occurs when docs become inconsistent with code changes. Drift detection validates existing documentation against the current codebase, automatically flagging broken references and outdated API information for correction.

How do I bootstrap documentation for reusable components and complex flows?

Bootstrapping documentation for reusable components involves scanning the codebase to identify utilities and complex flows, then creating minimal, token-efficient doc files using specific templates for features, components, and utilities.

Does this documentation validation work for migrating existing docs to a new format?

Yes, documentation validation supports migration by operating in specific modes to update and migrate documentation formats. It refines existing docs for clarity, token efficiency, and better AI trigger activation during the transition.

When should I refine documentation for token efficiency instead of rewriting it?

Refining documentation for token efficiency is ideal when existing docs are structurally sound but verbose. The refinement mode optimizes doc chunks for clarity and better AI trigger activation, treating documentation as a search index rather than rewriting from scratch.