← Back to Skills Marketplace
michealxie001

OpenClaw Doc Generator

by michealxie001 · GitHub ↗ · v1.1.0 · MIT-0
cross-platform ✓ Security Clean
103
Downloads
0
Stars
0
Active Installs
1
Versions
Install in OpenClaw
/install oc-docgen
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: generate docs and update README. Before using it: 1) Run it in a safe/test copy of your repo first because it writes/overwrites files (docs/, README.md). 2) If you plan to add the suggested CI steps, ensure the CI git push is intentional and that your CI tokens have appropriate scope. 3) Note SKILL.md references a diagram_generator file that isn't present in the bundle and api_generator conditionally imports a 'c-support' module from a nearby path — verify whether that external code exists and is trusted. 4) Review the generated changes (don't auto-commit without inspection). If you want, I can point out the exact lines where files are written and where external imports occur.
Capability Analysis
Type: OpenClaw Skill Name: oc-docgen Version: 1.1.0 The oc-docgen skill bundle is a legitimate documentation generation tool that parses Python and C/C++ source code to create API references, update README tables of contents, and generate architecture diagrams. The code (scripts/api_generator.py, scripts/readme_updater.py, and scripts/main.py) uses standard libraries like 'ast' for code analysis and 're' for text manipulation, with no evidence of data exfiltration, malicious execution, or prompt injection. It includes a graceful fallback for C/C++ support by checking for a sibling 'c-support' directory, which is consistent with a modular skill architecture.
Capability Assessment
Purpose & Capability
Name/description match the included code: CLI entrypoint, API extraction, and README updater. The files and commands shown are what you'd expect for a doc generator.
Instruction Scope
Runtime instructions run local Python scripts that read source files and write documentation and README.md. This is expected, but the skill will modify files in your repo (and the SKILL.md even suggests CI steps that run git push). There are no instructions to read unrelated system credentials or send data to external endpoints.
Install Mechanism
No install spec — instruction-only with bundled scripts. Nothing is downloaded or extracted from external URLs, so install risk is low. The code runs from the skill's scripts when invoked.
Credentials
The skill declares no required environment variables or credentials, which aligns with its purpose. The CI example in SKILL.md includes git push steps (which in practice require CI secrets) — those are just examples but could lead to unexpected pushes if copied verbatim in CI. Also the code conditionally attempts to add a 'c-support' path to sys.path (parent-parent-parent / 'c-support' / 'lib') to import a C parser if present; that may import code from an adjacent directory if it exists.
Persistence & Privilege
always:false (normal). The skill will write/update files in the repository (docs/, README.md). While it doesn't persist as an always-enabled skill or modify other skills, file-write behavior means it can change user content — review changes before committing or enabling automated CI commits.
How to Use
  1. Make sure OpenClaw is installed (local or Docker)
  2. Run the install command in chat: /install oc-docgen
  3. After installation, invoke the skill by name or use /oc-docgen
  4. Provide required inputs per the skill's parameter spec and get structured output
Version History
v1.1.0
Added C/C++ support: API documentation generation, Doxygen style support
Metadata
Slug oc-docgen
Version 1.1.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 103 downloads so far.

How do I install OpenClaw Doc Generator?

Run "/install oc-docgen" 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.1.0.

💬 Comments