ClawHub

Codebase Documenter

v0.1.0

This skill should be used when writing documentation for codebases, including README files, architecture documentation, code comments, and API documentation. Use this skill when users request help documenting their code, creating getting-started guides, explaining project structure, or making codebases more accessible to new developers. The skill provides templates, best practices, and structured approaches for creating clear, beginner-friendly documentation.

⭐ 1· 2.8k·10 current·12 all-time
byVeera@veeramanikandanr48
MIT-0
Download zip
LicenseMIT-0 · Free to use, modify, and redistribute. No attribution required.
Security Scan
VirusTotalVirusTotal
Benign
View report →
OpenClawOpenClaw
Benign
high confidence
✓
Purpose & Capability
The name, description, SKILL.md and the large set of README/API/ARCHITECTURE/CODE_COMMENTS templates all match the declared purpose of producing documentation; the small index.js is a harmless stub and package.json only identifies the package. No unrelated credentials, binaries, or config paths are requested.
ℹ
Instruction Scope
SKILL.md directs the agent to 'analyze the codebase' and map dependencies, which is appropriate for a documentation skill but implies the agent will need access to the user's repository content; the instructions do not ask the agent to read system-level files, environment variables, or transmit data to unknown external endpoints.
✓
Install Mechanism
There is no install spec (instruction-only plus a tiny JS stub), so nothing is downloaded or written to disk beyond the skill bundle itself — low install risk.
✓
Credentials
The skill declares no required environment variables, credentials, or config paths. Templates mention common env vars as examples (e.g., DATABASE_URL) but the skill does not require them.
✓
Persistence & Privilege
always:false (not forced into every agent), and autonomous invocation is allowed (the platform default). There is no evidence the skill requests permanent elevated presence or modifies other skills or system-wide configs.
Assessment
This skill appears coherent and low-risk, but exercise normal caution before using it with private code: 1) Verify the skill origin if you care about provenance (source/homepage is unknown). 2) Preview the templates and index.js (the JS is a no-op stub) to confirm there is no hidden behavior. 3) When asking the agent to 'analyze the codebase', avoid sending secrets or .env files — redact API keys, tokens, and passwords before sharing. 4) If you plan to let the agent access a private repo, grant minimal, temporary access and audit what is sent. 5) If you require legal/license assurances, check the included license/author metadata in package.json. Overall: functionally coherent for documenting codebases, but be careful about sharing sensitive project data when using it.

Like a lobster shell, security has layers — review code before you run it.

latestvk972a7xjh6a83yaqdr898je3xs808b2q

License

MIT-0
Free to use, modify, and redistribute. No attribution required.
Termshttps://spdx.org/licenses/MIT-0.html

Comments