{
  "id": "skl_8b772b805db6",
  "slug": "skill-readme-docs-generator",
  "asset_type": "skill",
  "name": "Open-Source README, Architecture Diagram & Mintlify Docs Skill",
  "tagline": "Generate developer-loved documentation from source code: quickstart CLI blocks, Mermaid system architecture diagrams, API parameter tables, and runnable co",
  "description_md": "### Overview & Capability Scope\n**Open-Source README, Architecture Diagram & Mintlify Docs Skill** (`skill-readme-docs-generator`) is a verified, portable `SKILL.md` playbook curated with **@nutlope** for Grok Bot (`x.ai/bot/`), Claude Code (`~/.claude/skills/`), and Cursor (`.cursor/skills/`).\n\nGenerate developer-loved documentation from source code: quickstart CLI blocks, Mermaid system architecture diagrams, API parameter tables, and runnable copy-paste examples.\n\n### Required Stack & Tooling\n- **Primary Stack:** Mintlify, Mermaid Diagrams, Developer Docs, OpenAPI\n- **Category:** `engineering`\n- **Source & Reference:** [https://mintlify.com/docs](https://mintlify.com/docs)\n\n### Quickstart Installation\nInstall this `SKILL.md` playbook directly into your agent workspace:\n```bash\nnpx lightstate install skill-readme-docs-generator\n```\nOr copy the complete `SKILL.md` specification below into `.cursor/skills/skill-readme-docs-generator/SKILL.md` or `~/.claude/skills/skill-readme-docs-generator/SKILL.md`.\n\n### Verification Commands\n```bash\nnpx mintlify dev\nnpx mintlify broken-links\n```\n",
  "primary_category": "engineering",
  "categories_json": "[\"engineering\", \"skills\"]",
  "tags_json": "[\"mintlify\", \"mermaid-diagrams\", \"developer-docs\", \"openapi\", \"skill-md\", \"engineering\"]",
  "compatible_agents_json": "[\"grok-bot\", \"claude-code\", \"cursor\"]",
  "integrations_json": "[\"Mintlify\", \"Mermaid Diagrams\", \"Developer Docs\"]",
  "includes_json": "[]",
  "safety_level": "Read-Only / Ask-First",
  "safety_summary": "Verified capability blueprint by @nutlope.",
  "share_url": "",
  "deep_link_uri": "",
  "mcp_endpoint": "",
  "mcp_transport": "http",
  "install_command": "npx lightstate install skill-readme-docs-generator",
  "skill_markdown": "---\nname: readme-docs-generator\ndescription: 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.\ntriggers:\n  - readme docs generator\n  - mintlify\n  - mermaid diagrams\n---\n\n# Open-Source README, Architecture Diagram & Mintlify Docs Skill\n\n## 1. When to Use This Skill\nLoad `skill-readme-docs-generator` whenever an engineering or operations task involves **Mintlify, Mermaid Diagrams, Developer Docs, OpenAPI**. Specifically:\n- Generate developer-loved documentation from source code: quickstart CLI blocks, Mermaid system architecture diagrams, API parameter tables, and runnable copy-paste examples.\n- Designing, reviewing, or debugging production configurations without guesswork or deprecated flags.\n- Running deterministic pre-flight and post-execution verification checks before reporting completion.\n\n## 2. Prerequisites & Required Environment\n- **Target Stack:** Mintlify, Mermaid Diagrams, Developer Docs, OpenAPI\n- **Permissions:** Read-only inspection by default; ask for explicit confirmation before executing destructive mutations or production deployments.\n- **Reference Repository:** `https://mintlify.com/docs`\n\n## 3. Step-by-Step Execution Playbook\n1. **Context & Configuration Discovery:**\n   Inspect existing project manifests (`package.json`, `wrangler.jsonc`, schema files, or environment declarations) before proposing changes. Never overwrite existing bindings or credentials blindly.\n2. **Deterministic Implementation:**\n   Apply the canonical patterns for **Mintlify**:\n   - Enforce strict schema/type validation at every external boundary.\n   - Include explicit error handling, structured logging, and idempotency keys on all mutating calls.\n   - Keep secrets in environment variables or secret stores—never hardcode tokens in source files.\n3. **Verification & Regression Gate:**\n   Run the verification commands below and inspect both exit codes and output payloads before marking the task complete.\n\n## 4. Reference Commands & CLI Workflow\n```bash\nnpx mintlify dev\nnpx mintlify broken-links\n```\n\n## 5. Edge Cases & Anti-Hallucination Guardrails\n- **Zero Unverified Claims:** Never claim a deployment, migration, or API call succeeded without inspecting the command output or HTTP status code.\n- **Rollback Readiness:** Always record the previous state or migration version so changes can be reverted cleanly if downstream health checks fail.\n",
  "starter_prompt": "Load the Open-Source README, Architecture Diagram & Mintlify Docs Skill (skill-readme-docs-generator) playbook. First inspect our current configuration and codebase for Mintlify, Mermaid Diagrams, Developer Docs, OpenAPI. Then propose a concrete, step-by-step implementation plan following the skill-readme-docs-generator guardrails, run the non-destructive verification commands (npx mintlify dev), and summarize any findings, risks, or required environment variables before making production changes.",
  "project_url": "https://mintlify.com/docs",
  "repo_url": "https://mintlify.com/docs",
  "creator_handle": "nutlope",
  "creator_name": "Hassan El Mghari (@nutlope)",
  "creator_avatar_url": null,
  "creator_url": "https://x.com/nutlope",
  "creator_platform": "x",
  "creator_cal_url": null,
  "claimed_by_user_id": null,
  "scouted_by_handle": null,
  "source_url": "https://mintlify.com/docs",
  "source_tweet_id": null,
  "source_origin": "certified_builder",
  "source_posted_at": null,
  "x_likes": 204,
  "x_bookmarks": 512,
  "x_retweets": 128,
  "x_views": 2856,
  "human_upvotes": 204,
  "human_installs": 204,
  "bot_pulls": 512,
  "pulse_score": 88,
  "gravity_rank_score": 1804,
  "is_featured": 0,
  "is_verified": 1,
  "is_sponsored": 0,
  "sponsor_tier": "free",
  "sponsor_label": "",
  "sponsor_cta_url": "",
  "sponsor_expires_at": null,
  "commercial_intent_score": 0,
  "status": "active",
  "created_at": "2026-10-24T20:00:00Z",
  "updated_at": "2026-10-24T20:00:00Z",
  "verified_at": null,
  "primitive": "skill",
  "title": "Open-Source README, Architecture Diagram & Mintlify Docs Skill",
  "description": "Generate developer-loved documentation from source code: quickstart CLI blocks, Mermaid system architecture diagrams, API parameter tables, and runnable co",
  "category": "engineering",
  "tags": "[\"mintlify\", \"mermaid-diagrams\", \"developer-docs\", \"openapi\", \"skill-md\", \"engineering\"]",
  "agent_compatibility": "[\"grok-bot\", \"claude-code\", \"cursor\"]",
  "author_handle": "nutlope",
  "author_name": "Hassan El Mghari (@nutlope)",
  "author_avatar": null,
  "source_tweet_url": "https://mintlify.com/docs",
  "github_url": "https://mintlify.com/docs",
  "external_url": "https://mintlify.com/docs",
  "upvotes_count": 204,
  "installs_count": 204
}