← Back to Skills Marketplace
Docs Generator
by
BytesAgain2
· GitHub ↗
· v2.0.0
· MIT-0
439
Downloads
0
Stars
1
Active Installs
9
Versions
Install in OpenClaw
/install docs-generator
Description
Automated documentation generator. API docs, README, CHANGELOG, contributing guide, architecture docs, tutorials, FAQ, reference manual. REST, GraphQL.
README (SKILL.md)
Docs Generator — Automated Documentation
Spend less time writing docs, more time writing code.
Command Map
┌─ api ──────── REST/GraphQL API documentation
├─ readme ───── Project README.md
├─ changelog ── Version change log
├─ contributing Contributing guide
├─ architecture System architecture docs
├─ tutorial ─── Tutorial / quick start guide
├─ faq ──────── Frequently asked questions
└─ reference ── Complete reference manual
Usage
bash scripts/docs-generator.sh api rest users
bash scripts/docs-generator.sh readme myproject "A cool tool"
bash scripts/docs-generator.sh changelog 2.0.0 "New features"
Arguments
api \x3Ctype> \x3Cresource>— type: rest/graphql, resource namereadme \x3Cname> \x3Cdesc>— project name and descriptionchangelog \x3Cver> \x3Csummary>— version and summarycontributing \x3Cproject>— project namearchitecture \x3Cproject> \x3Cstyle>— style: monolith/microservice/serverlesstutorial \x3Ctopic> \x3Clevel>— level: beginner/intermediate/advancedfaq \x3Ctopic> \x3Ccount>— generate N FAQ entriesreference \x3Clib> \x3Clang>— library name and language
Philosophy
Documentation is a product. Good docs = more users = fewer issues.
💬 Feedback & Feature Requests: https://bytesagain.com/feedback Powered by BytesAgain | bytesagain.com
Usage Guidance
This skill appears coherent and limited to generating documentation templates. Before installing or running scripts: (1) verify you are comfortable with a tool creating files under ~/.local/share/docs-generator (or the directory you set via DOCS_GENERATOR_DIR/XDG_DATA_HOME); (2) ensure python3 and bash are available; (3) inspect the included scripts (they are small and readable) and avoid running them as root; and (4) if you need network-free guarantees, note that the current scripts do not perform network calls, but always review future updates for added network behavior.
Capability Analysis
Type: OpenClaw Skill
Name: docs-generator
Version: 2.0.0
The skill bundle is a documentation generator that uses bash and Python to create templates for APIs, READMEs, and other project docs. While it contains a logic bug in `scripts/docs-generator.sh` that prevents custom arguments from being correctly passed to the underlying Python logic (resulting in default templates), and includes an auxiliary unused utility script (`scripts/script.sh`), there are no signs of malicious intent, data exfiltration, or harmful instructions. The scripts operate entirely locally and lack any network or sensitive file access.
Capability Assessment
Purpose & Capability
Name/description match the provided scripts and SKILL.md: the tool generates README, API docs, changelogs, etc. There are no unrelated binaries, credentials, or config paths requested.
Instruction Scope
SKILL.md simply instructs running the included scripts with documented arguments. The scripts generate text templates using local Python and bash and do not read unusual system files, shell history, or transmit data externally.
Install Mechanism
No install spec (instruction-only). The repository includes two small bash scripts that will be executed locally; nothing is downloaded or extracted from external URLs during install.
Credentials
The skill requires no environment variables or credentials. The scripts respect optional DOCS_GENERATOR_DIR/XDG_DATA_HOME/HOME for storing data — these are conventional and proportional to a local utility.
Persistence & Privilege
The helper creates a data directory (default: $XDG_DATA_HOME or $HOME/.local/share/docs-generator) and writes logs/data files there. This is expected for a local utility, but users should be aware it persists small files in their home directory.
How to Use
- Make sure OpenClaw is installed (local or Docker)
- Run the install command in chat:
/install docs-generator - After installation, invoke the skill by name or use
/docs-generator - Provide required inputs per the skill's parameter spec and get structured output
Version History
v2.0.0
v2.5 standard: Use-when desc, homepage, source, security fix
v2.3.3
yaml-fix+quality
v2.3.2
yaml-fix+quality
v2.3.1
Quality upgrade: custom functionality
v2.3.0
Quality fixes: removed third-party references, aligned docs with implementation
v2.2.0
Enhanced descriptions for better AI triggering
v1.0.2
Runtime fix
v1.0.1
- Removed the tips.md file to clean up and simplify the project.
- No other changes to commands, features, or documentation.
v1.0.0
- Initial release of Docs Generator.
- Automates creation of common project documentation: API docs (REST/GraphQL), README, changelog, contributing guide, architecture docs, tutorials, FAQ, and reference manuals.
- Simple CLI interface with clear command mapping for each documentation type.
- Supports customization for project specifics and doc styles.
Metadata
Frequently Asked Questions
What is Docs Generator?
Automated documentation generator. API docs, README, CHANGELOG, contributing guide, architecture docs, tutorials, FAQ, reference manual. REST, GraphQL. It is an AI Agent Skill for Claude Code / OpenClaw, with 439 downloads so far.
How do I install Docs Generator?
Run "/install docs-generator" in the OpenClaw or Claude Code chat to install it in one step — no extra setup required.
Is Docs Generator free?
Yes, Docs Generator is completely free, licensed under MIT-0. You can download, install and use it at no cost.
Which platforms does Docs Generator support?
Docs Generator is cross-platform and runs anywhere OpenClaw / Claude Code is available (cross-platform).
Who created Docs Generator?
It is built and maintained by BytesAgain2 (@ckchzh); the current version is v2.0.0.
More Skills