create-container-documentation

Generate README, CHANGELOG, OpenAPI spec, and event docs per Section 13.

Updated Aug 27, 2026
One-click install
npx skills add https://github.com/Edgame2/castiel2 --skill create-container-documentation
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: create-container-documentation
Source: https://github.com/Edgame2/castiel2/tree/main/.cursor/skills/create-container-documentation
Command: npx skills add https://github.com/Edgame2/castiel2 --skill create-container-documentation

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Manually creating consistent, standards-compliant documentation for new modules is time-consuming and error-prone; this skill generates the full set of docs automatically.

Core Features & Use Cases

  • Generates README.md with required sections (overview, setup, API endpoints, configuration)
  • Produces CHANGELOG.md using semantic versioning
  • Creates OpenAPI spec (openapi.yaml) and event documentation (logs-events.md, notifications-events.md)

Quick Start

Generate all documentation artifacts for a new or updated service following ModuleImplementationGuide Section 13.

Frequently Asked Questions about create-container-documentation

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

FAQPage Schema
How do I generate module documentation for a new service?

Generate module documentation by automatically producing README.md, CHANGELOG.md, and event documentation artifacts that comply with ModuleImplementationGuide Section 13 standards.

Can I create an OpenAPI specification automatically for my modular architecture?

Yes, you can create an OpenAPI specification by generating an openapi.yaml file alongside README.md and event documentation to standardize your modular architecture APIs.

How do I document events and notifications in a modular architecture?

Document events and notifications by generating dedicated logs-events.md and notifications-events.md files, ensuring all modular architecture event flows are properly captured.

How do I maintain a CHANGELOG with semantic versioning for API documentation?

Maintain a CHANGELOG with semantic versioning by automatically applying version increments and logging changes in the generated CHANGELOG.md file during documentation updates.

What is the best way to automate README.md creation with required sections like setup and configuration?

Automate README.md creation by generating required sections including overview, setup, API endpoints, and configuration, ensuring consistent standards-compliant module documentation.

Do I need any dependencies to generate standards-compliant documentation artifacts?

No dependencies are required to generate standards-compliant documentation artifacts, as the skill operates independently to produce README, CHANGELOG, OpenAPI, and event documentation files.