readme

The README generator is an expert-level technical writing tool designed to produce documentation that solves the "where do I start?" problem for developers joining a new codebase. It moves beyond standard templates to provide an "absurdly thorough" resource that guides users from a fresh machine setup to production maintenance. The tool performs a deep, recursive exploration of the target repository, analyzing structure, configuration files, environment variables, dependencies, and deployment manifests. It is ideal for lead developers, open-source maintainers, and team leads who need to ensure their projects remain accessible and well-documented without the manual burden of writing lengthy technical guides from scratch.

• Automatically maps project structure and identifies technology stacks including Ruby on Rails, Node.js, Docker, and various cloud deployment platforms like Fly.io, Vercel, and Render.

• Generates comprehensive sections covering local development workflows, architecture deep-dives (including data flow and request lifecycles), environment variable references, and testing procedures.

• Identifies deployment targets and creates tailored instructions based on existing infrastructure, such as Dockerfiles, database migrations, or CI/CD configuration files.

• Provides a robust troubleshooting guide that anticipates common bottlenecks like database connection issues, asset compilation failures, and dependency conflicts.

• Uses a high-quality Markdown output format that includes linked tables of contents, copy-pasteable bash commands, and standardized code blocks.

• To trigger, use natural language requests such as "create a readme," "document this project," or "write a readme for this codebase."

• The tool expects to operate on an existing project root; it analyzes files like Gemfile, package.json, Procfile, or db/schema.rb to construct its narrative.

• Users should ensure their codebase is organized such that configuration files are accessible; the tool will parse these to build an accurate table of required environment variables.

• Output is written directly to the project's root README.md file, ensuring immediate integration into the development workflow.