documentation from code

Documentation Community

Skill notes

When to Use

When you need to create or update documentation from existing code. Generates README files, API documentation, architecture overviews, and inline documentation improvements.

Procedure

Read the codebase structure using filesystem.list Identify entry points, public APIs, and key modules Read source files to understand functionality Extract docstrings, type hints, and comments Generate documentation in appropriate format (Markdown, JSDoc, etc.)

Example 1: Generate README

Input: "Generate a README for this project" Walkthrough: List project root files to understand structure Read package.json, Cargo.toml, or similar for metadata Read main source files to understand functionality

Example 2: API documentation

Input: "Document the REST API endpoints" Walkthrough: Find route definitions in the codebase Extract HTTP methods, paths, parameters, and response types Read validation schemas for request/response shapes

Fluxly profile Runtime and permissions are inferred by Fluxly static checks, not author declarations or runtime test results.
Domain
Documentation
Author-declared agents
No explicit declaration found; this is not inferred or tested compatibility
Static check
88 / 100 · heuristic scan, not runtime safety proof
Runtime evidence
Not run; no isolated runtime test evidence is currently recorded
Author / version / license
@tomevault-io · no license declared
Token usage
Lean
Setup complexity
Plug-and-play
External API key
Not required
Operating systems
Unspecified (assume cross-platform)
Runtime requirements
No explicit requirements detected
Detected file/system behavior
  • Read-only
  • Write / modify
Network behavior
Local-only
Install commands
None (reference only)

Heads up: Tool permissions are not declared; actual access depends on the runtime.

Author source file SKILL.md

# Documentation from Code Skill

## When to Use
When you need to create or update documentation from existing code. Generates README files,
API documentation, architecture overviews, and inline documentation improvements.

## Procedure
1. Read the codebase structure using `filesystem.list`
2. Identify entry points, public APIs, and key modules
3. Read source files to understand functionality
4. Extract docstrings, type hints, and comments
5. Generate documentation in appropriate format (Markdown, JSDoc, etc.)
6. Write documentation files using `filesystem.write`
7. Verify generated docs are accurate and complete

## Examples

### Example 1: Generate README
Input: "Generate a README for this project"
Walkthrough:
1. List project root files to understand structure
2. Read package.json, Cargo.toml, or similar for metadata
3. Read main source files to understand functionality
4. Identify installation steps, usage examples, and API overview
5. Generate README with sections: Install, Usage, API, Contributing, License
6. Write README.md to project root

### Example 2: API documentation
Input: "Document the REST API endpoints"
Walkthrough:
1. Find route definitions in the codebase
2. Extract HTTP methods, paths, parameters, and response types
3. Read validation schemas for request/response shapes
4. Generate OpenAPI/Swagger-style documentation
5. Include example requests and responses

---
> Source: [daniel-silva-perez/zeus](https://github.com/daniel-silva-perez/zeus) — distributed by [TomeVault](https://tomevault.io).
<!-- tomevault:4.0:skill_md:2026-05-22 -->

Discussion

Powered by GitHub Discussions. Sign in with GitHub to comment, react, or subscribe.