technical-documentation

Generate structured markdown documentation by providing a Table of Contents to automatically create .technical.md files for each chapter. This enforces a top-down organization with clear headings and cross-linking between chapters.

API documentation generation requires a 'documentation' folder at the repository root. A strict file naming convention is followed to ensure all generated .technical.md files maintain structural consistency.

The best way to maintain technical documentation is to use a Skill that generates an initial structure covering functional descriptions, technical overviews, and API details. This ensures all required elements are present from the start.

You can create an architecture overview in markdown by generating structured .technical.md files based on your table of contents. The automated process enforces clear headings and cross-linking for comprehensive architecture documentation.

Limitations of using .technical.md files include a strict file naming convention and the mandatory creation of a 'documentation' folder at the repository root. Content is exclusively generated in Markdown format with structured chapters.