← Back to Skills Marketplace
Code Documentor
by
rupertnt034
· GitHub ↗
· v1.0.0
· MIT-0
231
Downloads
0
Stars
0
Active Installs
1
Versions
Install in OpenClaw
/install rupert-code-documentor
Description
Automatically generate detailed and convention-compliant documentation for codebases in multiple languages, including README, API docs, and function comments.
Usage Guidance
This skill appears coherent and doesn't request credentials or perform installs, but it will need access to your codebase to generate docs. Before using it: (1) run it on a copy or limit the requested files/directories to avoid exposing secrets; (2) review generated documentation for accidental inclusion of private data (keys, tokens, internal paths); (3) confirm license and third-party attribution in generated READMEs and API docs; and (4) if you allow autonomous runs, consider restricting its scope or confirming each run so it doesn't scan the entire repository automatically.
Capability Analysis
Type: OpenClaw Skill
Name: rupert-code-documentor
Version: 1.0.0
The skill bundle is a standard documentation generation tool for an AI agent. It contains only metadata and markdown instructions (SKILL.md) defining templates and commands for creating READMEs and API documentation, with no executable code, network requests, or suspicious prompt-injection attempts.
Capability Assessment
Purpose & Capability
Name and description match the SKILL.md content: templates, supported languages, and commands are all consistent with a code documentation generator. There are no unrelated environment variables, binaries, or config paths requested.
Instruction Scope
SKILL.md gives templates and user-facing commands (e.g., 'document this code', 'generate README for [project]'). It does not instruct the agent to contact external endpoints or access system-wide credentials, but it is somewhat vague about which files or directories to operate on and does not include guidance to avoid secrets or large-scale repository scanning. This grants the agent normal discretionary access to the repository/workspace when invoked — expected for this type of skill, but users should limit scope when running it.
Install Mechanism
Instruction-only skill with no install spec and no code files — nothing is written to disk by an installer, which minimizes install-time risk.
Credentials
No environment variables, credentials, or config paths are requested. The lack of secret requests is appropriate for a document-generation skill.
Persistence & Privilege
always is false and the skill does not request persistent or elevated privileges. Autonomous invocation is allowed by platform default but the skill itself does not demand extra system presence or modify other skills.
How to Use
- Make sure OpenClaw is installed (local or Docker)
- Run the install command in chat:
/install rupert-code-documentor - After installation, invoke the skill by name or use
/rupert-code-documentor - Provide required inputs per the skill's parameter spec and get structured output
Version History
v1.0.0
- Initial release of Code Documentor Skill.
- Automatically generates documentation for codebases in multiple languages, including Python, JavaScript/TypeScript, Swift, Go, Rust, and Java.
- Supports creation of project READMEs, API references, architecture docs, contributing guides, and changelogs.
- Provides commands for documenting code, functions, endpoints, and generating custom documentation files.
- Includes templates for READMEs and function documentation.
- Configuration options for documentation style, inclusion of examples, target language, and output format.
Metadata
Frequently Asked Questions
What is Code Documentor?
Automatically generate detailed and convention-compliant documentation for codebases in multiple languages, including README, API docs, and function comments. It is an AI Agent Skill for Claude Code / OpenClaw, with 231 downloads so far.
How do I install Code Documentor?
Run "/install rupert-code-documentor" in the OpenClaw or Claude Code chat to install it in one step — no extra setup required.
Is Code Documentor free?
Yes, Code Documentor is completely free, licensed under MIT-0. You can download, install and use it at no cost.
Which platforms does Code Documentor support?
Code Documentor is cross-platform and runs anywhere OpenClaw / Claude Code is available (cross-platform).
Who created Code Documentor?
It is built and maintained by rupertnt034 (@rupertnt034); the current version is v1.0.0.
More Skills