readme-generator

name	readme-generator
description	Generate a complete, professional, enterprise-grade README.md with collapsible deep-dives, architecture diagrams, environment setup, API docs, data models, testing strategy, security, contributing guide, and troubleshooting. Uses expandable sections to keep high-level docs concise while detailed documentation is expandable.
user-invokable	true
args	[{"name":"target","description":"The project to document (optional)","required":false}]

Generate a COMPLETE, PROFESSIONAL, CONTRIBUTOR-READY README.md for the entire codebase. Analyze the entire repository before writing anything: all folders, files, configs, scripts, tests, CI/CD workflows, infrastructure, env vars, and dependency manifests.

Required Sections

1. Project Name & Overview — What it does, who it's for, problem it solves.
2. Table of Contents — Anchor links.
3. Architecture — High-level diagram, frontend/backend structure, data flow, auth flow.
4. Tech Stack — Each technology: what it's used for, why chosen, link to official docs.
5. Folder & File Structure — Tree breakdown with collapsible deep-dives per directory.
6. Environment Setup — Prerequisites, installation steps, env vars table.
7. Authentication & Authorization — Token flows, scopes, role requirements.
8. API Integrations — Each external API: purpose, base URL, scopes, rate limits, official docs link.
9. Data Models — Core entities, mapping logic, transformation layers.
10. Frontend Documentation — Components, state, routing, data fetching, styling.
11. Backend Documentation — Server structure, middleware, routing, services, error handling.
12. Testing Strategy — Unit, integration, E2E, how to run, coverage expectations.
13. Scripts & Automation — Every script explained.
14. Security Considerations — Token storage, input validation, logging hygiene.
15. Performance Considerations — Caching, pagination, lazy loading.
16. Contributing Guide — Code style, branch strategy, PR requirements, commit conventions.
17. Extending the Project — How to add endpoints, pages, integrations, models.
18. Troubleshooting — Common issues and solutions.
19. FAQ

Formatting Requirements

• Clean markdown hierarchy.
• Tables where helpful.
• Code blocks for commands.
• Use collapsible <details> sections for deep dives.
• Keep main sections concise; deep explanations inside collapsible sections.
• Use graphics and icons to keep it engaging.

External References

• Identify dependencies from package manifests and imports.
• Link to official documentation and GitHub repos.
• Cite version numbers when available.
• Never invent references or cite unofficial blogs as primary sources.

Quality Bar

• Enterprise-grade, suitable for public open-source release.
• Not overwhelming for beginners, satisfying for senior engineers.
• Requires no additional explanation outside the document.

Validation Before Output

1. Every major folder documented.
2. Every integration documented.
3. Every external dependency referenced.
4. Setup instructions complete.
5. Collapsible deep sections exist.
6. No placeholder text remains.
7. Formatting renders properly in GitHub Markdown.