π¦ ClawHubβ¦ BytesAgain
Docs Generator
by @ckchzh
Automated documentation generator. API docs, README, CHANGELOG, contributing guide, architecture docs, tutorials, FAQ, reference manual. REST, GraphQL.
TERMINAL
clawhub install docs-generatorπ About This Skill
version: "2.0.0" name: Docs Generator description: "Automated documentation generator. API docs, README, CHANGELOG, contributing guide, architecture docs, tutorials, FAQ, reference manual. REST, GraphQL." author: BytesAgain homepage: https://bytesagain.com source: https://github.com/bytesagain/ai-skills
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 β type: rest/graphql, resource namereadme β project name and descriptionchangelog β version and summarycontributing β project namearchitecture β style: monolith/microservice/serverlesstutorial β level: beginner/intermediate/advancedfaq β generate N FAQ entriesreference β library name and languagePhilosophy
Documentation is a product. Good docs = more users = fewer issues.
π¬ Feedback & Feature Requests: https://bytesagain.com/feedback Powered by BytesAgain | bytesagain.com
π‘ Examples
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"