Documentation Architecture Skill

Generate OpenAPI 3.1 specs from FastAPI code with CI/CD coverage validation.

29|4|Updated Aug 10, 2025

Ready to run

npx skills add https://github.com/greyhaven-ai/claude-code-config --skill documentation-architecture-skill

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: Documentation Architecture Skill
Source: https://github.com/greyhaven-ai/claude-code-config/tree/main/grey-haven-plugins/developer-experience/skills/documentation-architecture
Command: npx skills add https://github.com/greyhaven-ai/claude-code-config --skill documentation-architecture-skill

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires ts-morph, jinja2, ast, and includes references (resource) and examples (resource) and templates (resource) components.

What problem does it solve?

This Skill eliminates the complexity of manual documentation by providing automated generation, coverage validation, and architecture visualization.

Core Features & Use Cases

Automated API Documentation: Generate comprehensive OpenAPI specs from FastAPI code with multi-language examples.
Coverage Enforcement: Automatically validate documentation coverage with 80% thresholds in CI/CD.
Use Case: Imagine your team spends 4+ hours weekly updating API docs. Use this Skill to auto-generate OpenAPI specifications with interactive Swagger UI on every commit.

Quick Start

Use this Skill to generate an OpenAPI 3.1 specification from your FastAPI codebase.

Frequently Asked Questions about Documentation Architecture Skill

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

FAQPage Schema

How do I automate API documentation generation from FastAPI code?▼

Automate API documentation by generating OpenAPI 3.1 specifications directly from your FastAPI codebase. This Skill extracts endpoint definitions, request/response schemas, and multi-language examples to produce Swagger UI documentation on every commit, eliminating manual updates.

Can I enforce documentation coverage in CI/CD pipelines?▼

Yes. Set automated coverage validation thresholds—such as 80%—within CI/CD to block deployments when documentation gaps exist. This Skill integrates validation checks that catch missing API docs, architecture decisions, and template compliance before merge.

What's the best way to structure versioning and search across fragmented documentation?▼

Design scalable documentation architecture using integrated versioning strategies and indexed search across API docs, architecture diagrams, ADRs, and templates. This Skill consolidates multiple documentation formats into a unified, searchable system within your existing toolchain.

Does this work with large-scale, multi-repository documentation projects?▼

Yes. This Skill handles large-scale documentation by automating generation pipelines, managing multi-language examples, and enforcing consistency across distributed repositories. It scales from single services to complex microservices architectures with centralized quality control.

How do ts-morph, Jinja2, and AST parsing work together in documentation generation?▼

This Skill uses ts-morph to parse TypeScript/JavaScript source code, AST to analyze Python and language-agnostic syntax trees, and Jinja2 templating to render consistent documentation output. Together they extract code structure and generate formatted docs from source.

What happens if documentation templates or API specs become inconsistent across versions?▼

Inconsistencies are caught by automated validation and template enforcement within CI/CD. This Skill detects drift between versioned specs, enforces schema compliance, and flags template violations before they propagate to production documentation.