skills.rest
Rkaaaa404
Rkaaaa404COMMUNITY
Explore all skills by this author →
GitHub

generate-docs

Generate and update Markdown documentation for API endpoints, components, hooks, and schemas.

Updated May 27, 2026
Search Tags:#changelog#documentation#markdown#code generation#api reference#component docs#daas
One-click install
npx skills add https://github.com/Rkaaaa404/cyberhack-SYDT --skill generate-docs-rkaaaa404
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: generate-docs
Source: https://github.com/Rkaaaa404/cyberhack-SYDT/tree/main/.agents/skills/generate-docs
Command: npx skills add https://github.com/Rkaaaa404/cyberhack-SYDT --skill generate-docs-rkaaaa404

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve? Code changes often ship without matching documentation, leaving API references, component catalogs, and changelogs stale or missing. This Skill enforces a documentation-first workflow so every code change in a DaaS application produces the required docs. ## Core Features & Use Cases - Change-Type Mapping: Maps each change (API endpoint, component, hook, collection, feature, workflow) to the exact documentation files that must be created or updated. - Ready-Made Templates: Provides copy-paste Markdown templates for API routes, React components, hooks, collections, and features, plus a mandatory CHANGELOG.md entry format. - Use Case: After adding a new /api/shipments endpoint, invoke this Skill to generate the endpoint entry in docs/API_REFERENCE.md, a detailed page in docs/api/shipments.md, and a dated changelog entry. ## Quick Start Ask the assistant to generate documentation for the new API endpoint you just created, including the API reference entry and changelog update.

Frequently Asked Questions about generate-docs

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I generate documentation for a new API endpoint?▼

Invoke the skill with the endpoint name, and it produces an entry in docs/API_REFERENCE.md plus a detailed page in docs/api/[collection].md. The template covers request headers, query parameters, body fields, response codes, and cURL and TypeScript examples.

What documentation is required when I create a React component?▼

Component changes require an entry in docs/COMPONENTS.md and a full page in docs/components/[name].md. The template includes import statements, a props table with types and defaults, usage examples, and a changelog section.

Does this skill support documenting custom React hooks?▼

Yes, hooks are documented in docs/HOOKS.md using a defined format covering the import path, TypeScript signature, parameters table, return values, and a working usage example.

Is updating the changelog mandatory for every code change?▼

Yes, the skill mandates a dated docs/CHANGELOG.md entry for any change, regardless of type. Entries follow an Added, Changed, Fixed, Deprecated, and Removed structure with links to related documentation.

What documentation is needed for a new data collection or schema?▼

New collections require an overview in docs/COLLECTIONS.md, API docs in docs/api/[collection].md, a JSON schema file, and an example data file under docs/schemas/. Modified schemas also need migration notes.

Related Skills

Explore More Software Engineering Skills→
Jicate-SolutionsJicate-Solutions

nextjs-module-builder

Generate Next.js CRUD modules with TypeScript, Supabase services, React hooks, UI components, and routing.

Official
Advanced
koralliskorallis
90

documentation-generation

Automates generation of technical documentation for software projects.

Community
Advanced
carrot-foundationcarrot-foundation
1

verifier

Validate tests, JSON schemas, and version consistency in completed work.

Official
Advanced
nashirabbashnashirabbash

api-documentation

Generate OpenAPI specs and interactive documentation for REST and GraphQL APIs.

Community
Intermediate