OpenClaw Doc Generator
v1.0.0Generates documentation from code. Creates API docs, README updates, architecture diagrams, and keeps documentation in sync with code changes.
⭐ 0· 41·0 current·0 all-time
MIT-0
Download zip
LicenseMIT-0 · Free to use, modify, and redistribute. No attribution required.
Security Scan
OpenClaw
Benign
high confidencePurpose & 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.
Assessment
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.Like a lobster shell, security has layers — review code before you run it.
latestvk976kabexjf51dc5ewbptjk46d841t3j
License
MIT-0
Free to use, modify, and redistribute. No attribution required.