An automated software documentation generator that scans local directory codebases to automatically produce structured READMEs, API references, and usage guides.
Install & Download
1. ClawHub CLI
The fastest way to install a skill directly from the registry.
npx clawhub@latest install thoth
2. Manual Installation
Copy the skill folder to one of these locations
~/.openclaw/skills/ <project>/skills/ Priority: Workspace > Local > Bundled
3. Prompt Installation
Copy this prompt to OpenClaw to install it automatically.
Help me install thoth using Clawhub. If Clawhub is not installed, install it first (npm i -g clawhub).
Prefer to download?
Get the raw skill files in a ZIP archive.
What is Thoth Standard?
Thoth Standard is an automated documentation assistant designed to streamline documentation workflows across development projects. Built to minimize the tedious task of manual developer documentation, this engine scans your files to construct clear, thorough reference manuals. This integration works seamlessly with various workflows, positioning itself as a robust option among Openclaw Skills for automated developer documentation.
Whether utilizing Python, JavaScript, Go, or Rust, Thoth Standard automatically excludes temporary environment directories while parsing core project files. For Python projects, it utilizes Abstract Syntax Trees (AST) to automatically extract functions, classes, and docstrings, enabling LLMs to understand the logic and generate consistent API documentation.
Thoth Standard Use Cases
- Accelerating initial developer onboarding by generating complete README and architectural usage guides dynamically.
- Extracting accurate API signatures directly from Python codebase AST structures without manual writing.
- Standardizing development document structures across microservices or multi-repository workflows.
- Integrating high-quality automatic documentation generation into continuous workflows or developer setups using Openclaw Skills.
How Thoth Standard Works
- Dependency Verification: The tool ensures all runtime system dependencies, including python3 and pip3, along with CLI reporting tools, are configured.
- Validation and Scanning: The engine performs scanning routines across the project directory, skipping environment blocks, builds, and package modules.
- Syntax Extraction: The code parser extracts metadata configurations (e.g., package.json or pyproject.toml) and parses local AST nodes to gather classes, methods, arguments, and docstrings.
- Context Construction: Formatted codebase maps are prepared for the LLM to guide documentation generation.
- Documentation Assembly: Three distinct, structured documents (README.md, API_REFERENCE.md, and USAGE_GUIDE.md) are output directly to the specified directory.
Thoth Standard Setup
To set up Thoth Standard, follow the steps below:
- Install the CLI reporting packages:
pip3 install rich --break-system-packages --quiet
- Configure the required environment variables in your Openclaw Skills workspace setup:
LICENSE_KEY: Your valid Thoth Standard license key (e.g., starts withTHOTH-STD-).PROJECT_PATH: The absolute or relative path to the directory hosting the project to document.
- Configure optional settings:
PROJECT_NAME: Custom name override for the project.OUTPUT_DIR: Folder path where files should be output (defaults to./docs).
Thoth Standard Data Schema & Taxonomy
Thoth Standard generates a structured catalog of files inside your designated output folder. The layout is detailed below:
| Output File Name | Target Content Description | Output Format |
|---|---|---|
README.md |
Contains project overview, features list, exact installation directives, usage tutorials, and config settings. | Markdown |
API_REFERENCE.md |
Provides cataloged listings of classes, methods, and functions including arguments and docstring descriptions. | Markdown |
USAGE_GUIDE.md |
Supplies interactive, real-world tutorials inspired by the source codebase. | Markdown |
Exclusion Taxonomy
To maintain high-quality documentation, the parser skips target folders such as .git, __pycache__, node_modules, .venv, venv, dist, build, .next, and .pytest_cache.
Thoth Standard Advanced Features
- AST Node Introspection: Evaluates python methods to map parameter structures, module-level symbols, and function scopes.
- Multi-Language Parsing: Supports scanning and documenting diverse code assets written in Python, Rust, Go, TypeScript, and standard shell scripts.
- Visual Rich CLI Reports: Renders tables and output logs directly in terminal sessions.
- Openclaw Skills Ecosystem Compatibility: Configured to work seamlessly with multi-agent pipelines to support automated coding cycles.
SKILL.md
Loading
Related Openclaw Skills
Mind Map Creation Expert
An AI agent skill designed to break down complex knowledge domains into structured, hierarchical markdown mind maps.
EdgeOne Pages Full-Stack Website Skeleton Builder
An AI-driven full-stack scaffolding tool that generates and automatically deploys highly secure, high-performance web applications onto Tencent's EdgeOne Pages platform.
Horus Pro
Horus Pro is a comprehensive meeting intelligence suite that transforms raw transcripts and notes into structured briefings, action trackers, stakeholder digests, future agendas, and follow-up emails.
Zhihu AIOps Integration Skill
An AI agent skill that integrates with the Zhihu AIOps platform to automate IT asset discovery, health monitoring, smart inspections, and VictoriaMetrics time-series query workflows.
Ra Lite
An AI-powered research assistant skill that instantly searches the web and synthesizes a structured, three-source research brief on any topic.
Horus Lite
A lightweight, AI-powered meeting intelligence skill that instantly parses messy transcripts and notes into structured action items and summaries.
Featured*
