diataxis:readme

To write a README that routes readers to deeper documentation, generate a concise landing page skeleton with an elevator pitch, core features, and a clear map linking to tutorials, how-tos, and references.

The Diataxis framework structures a repository landing page as a front door that orients readers, routing them to distinct documentation types like tutorials, how-tos, references, and explanations rather than acting as a full manual.

Yes, you can use this approach for open source projects, libraries, and small teams needing a scalable documentation homepage that orients readers without becoming a tutorial or full reference manual.

A GitHub README acting as a project front door should include a problem statement, project name, elevator pitch, target audience, core features, a quick-start example, and a documentation map.

You should avoid putting tutorials directly in your README landing page when the goal is to orient readers and route them to deeper docs, keeping the front door concise rather than acting as a full reference manual.