docs-from-code

Generate README.md and API reference docs from a codebase knowledge graph.

581|60|Updated Apr 13, 2026
One-click install
npx skills add https://github.com/Varnan-Tech/opendirectory --skill docs-from-code-varnan-tech
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: docs-from-code
Source: https://github.com/Varnan-Tech/opendirectory/tree/main/skills/docs-from-code
Command: npx skills add https://github.com/Varnan-Tech/opendirectory --skill docs-from-code-varnan-tech

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill automates the generation of README.md, API reference docs, and an Architecture section by reading your codebase, saving you time and ensuring accurate documentation.

Core Features & Use Cases

  • Automated Documentation: Generates README.md, API reference docs, and an Architecture section based on your codebase.
  • Code Analysis: Uses graphify to build a knowledge graph of your codebase and extract relevant information.
  • Documentation Updates: Updates existing documentation when your codebase changes, ensuring it remains accurate.
  • Use Case: Install this Skill in your project to automatically generate a comprehensive README and API reference, saving you the time and effort of writing it manually.

Quick Start

Inside your project directory, run: npx "@opendirectory.dev/skills" install docs-from-code --target claude.

Frequently Asked Questions about docs-from-code

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

FAQPage Schema
How do I generate a README and API reference directly from my codebase?

Generate a README and API reference by reading your codebase's functions, routes, types, and schemas. The Skill builds a knowledge graph first, then writes accurate documentation from it to automate your technical writing.

Can I update outdated code documentation automatically when my codebase changes?

Yes, you can update outdated code documentation automatically. It reads your modified codebase, extracts the updated functions and schemas, and regenerates the README and API reference docs to ensure they remain accurate.

How does code analysis work for automated technical writing?

Automated technical writing works by using graphify to build a knowledge graph of your codebase. It extracts relevant information like functions, routes, and architecture from the graph to write accurate docs.

What is the best way to document a project architecture without writing it manually?

The best way to document project architecture without writing manually is to use a codebase analysis tool. It reads your code structure and automatically generates an architecture section and API reference.

Do I need a specific programming language to generate API documentation from code?

No, you do not need a specific programming language to generate API documentation. You can document a project in any language by reading its functions, routes, types, and schemas.

Are there limitations to generating an API reference from a knowledge graph?

Generating an API reference from a knowledge graph relies on reading your codebase's functions, routes, types, and schemas. If your code lacks clear schemas or typed routes, the resulting documentation may be less detailed.