Open-Source README, Architecture Diagram & Mintlify Docs Skill

Generate developer-loved documentation from source code: quickstart CLI blocks, Mermaid system architecture diagrams, API parameter tables, and runnable co

---
name: readme-docs-generator
description: Generate developer-loved documentation from source code: quickstart CLI blocks, Mermaid system architecture diagrams, API parameter tables, and runnable copy-paste examples. Use when working with Mintlify, Mermaid Diagrams, Developer Docs, OpenAPI.
triggers:
  - readme docs generator
  - mintlify
  - mermaid diagrams
---

# Open-Source README, Architecture Diagram & Mintlify Docs Skill

## 1. When to Use This Skill
Load `skill-readme-docs-generator` whenever an engineering or operations task involves **Mintlify, Mermaid Diagrams, Developer Docs, OpenAPI**. Specifically:
- Generate developer-loved documentation from source code: quickstart CLI blocks, Mermaid system architecture diagrams, API parameter tables, and runnable copy-paste examples.
- Designing, reviewing, or debugging production configurations without guesswork or deprecated flags.
- Running deterministic pre-flight and post-execution verification checks before reporting completion.

## 2. Prerequisites & Required Environment
- **Target Stack:** Mintlify, Mermaid Diagrams, Developer Docs, OpenAPI
- **Permissions:** Read-only inspection by default; ask for explicit confirmation before executing destructive mutations or production deployments.
- **Reference Repository:** `https://mintlify.com/docs`

## 3. Step-by-Step Execution Playbook
1. **Context & Configuration Discovery:**
   Inspect existing project manifests (`package.json`, `wrangler.jsonc`, schema files, or environment declarations) before proposing changes. Never overwrite existing bindings or credentials blindly.
2. **Deterministic Implementation:**
   Apply the canonical patterns for **Mintlify**:
   - Enforce strict schema/type validation at every external boundary.
   - Include explicit error handling, structured logging, and idempotency keys on all mutating calls.
   - Keep secrets in environment variables or secret stores—never hardcode tokens in source files.
3. **Verification & Regression Gate:**
   Run the verification commands below and inspect both exit codes and output payloads before marking the task complete.

## 4. Reference Commands & CLI Workflow
```bash
npx mintlify dev
npx mintlify broken-links
```

## 5. Edge Cases & Anti-Hallucination Guardrails
- **Zero Unverified Claims:** Never claim a deployment, migration, or API call succeeded without inspecting the command output or HTTP status code.
- **Rollback Readiness:** Always record the previous state or migration version so changes can be reverted cleanly if downstream health checks fail.

Synthesized Engineering Blueprint & Setup Guide