← Back to Skills Marketplace
michealxie001

OpenClaw Doc Generator

by michealxie001 · GitHub ↗ · v1.0.0 · MIT-0
cross-platform ✓ Security Clean
113
Downloads
0
Stars
0
Active Installs
1
Versions
Install in OpenClaw
/install openclaw-doc-gen
Description
Generates documentation from code. Creates API docs, README updates, architecture diagrams, and keeps documentation in sync with code changes.
Usage Guidance
This skill appears to do what it says: it scans Python source and updates/creates documentation and the README. Before installing or running it, (1) understand it will write to your repository (README.md and docs/), so commit/back up changes or run in a throwaway clone; (2) review the included scripts yourself—particularly readme_updater.py which overwrites README sections—to ensure the TOC/API insertion behavior matches your expectations; (3) note a minor inconsistency: SKILL.md mentions a diagram_generator.py file and CI paths that are not present in the provided manifest—verify whether additional files are missing or paths in your CI must be adjusted; (4) because the tool writes files, run it locally first (not on production branches) and inspect changes before pushing; and (5) no credentials or network calls were found, so there is no immediate secret-exfiltration risk in the provided code, but always review any future updates for added networking or credential access.
Capability Analysis
Type: OpenClaw Skill Name: openclaw-doc-gen Version: 1.0.0 The skill bundle is a legitimate documentation generator that uses Python's 'ast' module to parse source code and generate Markdown documentation. The code (api_generator.py, readme_updater.py, main.py) relies solely on the Python standard library, contains no dangerous execution sinks like eval() or subprocess, and performs no network or sensitive file access. The instructions in SKILL.md are consistent with the tool's functionality and do not contain prompt injection or malicious directives.
Capability Assessment
Purpose & Capability
The name/description (doc generation, README updates, diagrams, sync checks) align with the included scripts: api_generator.py, readme_updater.py, and main.py implement API docs generation, README modification, diagram printing, and sync checks. No unrelated credentials, binaries, or config paths are requested.
Instruction Scope
SKILL.md instructs running the included scripts (python3 scripts/main.py ...). The scripts legitimately read source files and write docs/ and README.md. This is expected, but note: the skill will modify repository files (README.md, docs/*). The SKILL.md also references a diagram_generator.py and a CI path 'skills/documentation-generator/scripts/main.py' that do not match the provided manifest (scripts/diagram_generator.py is not present), which is an inconsistency to verify.
Install Mechanism
No install spec provided; this is an instruction-only skill that runs local Python scripts. No network downloads or external package installs are performed by the skill itself.
Credentials
The skill declares no required environment variables, credentials, or config paths. The code does not attempt to read environment secrets or external credential files. Its file I/O is limited to repository files under the provided root.
Persistence & Privilege
always is false and there is no code that modifies other skills or system-wide agent settings. The skill will write files in the repository (docs/, README.md) which is expected for a documentation tool, but it does not request persistent platform privileges.
How to Use
  1. Make sure OpenClaw is installed (local or Docker)
  2. Run the install command in chat: /install openclaw-doc-gen
  3. After installation, invoke the skill by name or use /openclaw-doc-gen
  4. Provide required inputs per the skill's parameter spec and get structured output
Version History
v1.0.0
Generate API documentation from Python code, update README, and check doc sync
Metadata
Slug openclaw-doc-gen
Version 1.0.0
License MIT-0
All-time Installs 0
Active Installs 0
Total Versions 1
Frequently Asked Questions

What is OpenClaw Doc Generator?

Generates documentation from code. Creates API docs, README updates, architecture diagrams, and keeps documentation in sync with code changes. It is an AI Agent Skill for Claude Code / OpenClaw, with 113 downloads so far.

How do I install OpenClaw Doc Generator?

Run "/install openclaw-doc-gen" in the OpenClaw or Claude Code chat to install it in one step — no extra setup required.

Is OpenClaw Doc Generator free?

Yes, OpenClaw Doc Generator is completely free, licensed under MIT-0. You can download, install and use it at no cost.

Which platforms does OpenClaw Doc Generator support?

OpenClaw Doc Generator is cross-platform and runs anywhere OpenClaw / Claude Code is available (cross-platform).

Who created OpenClaw Doc Generator?

It is built and maintained by michealxie001 (@michealxie001); the current version is v1.0.0.

💬 Comments