readme-review

To check if your README is missing required sections, a structural review evaluates the file against the correct project type specification and judges each section as Missing, Weak, or OK. It flags structural anti-patterns like missing quick starts, zombie sections, depth mismatch, and over-structuring.

The best way to generate a README for a monorepo or library is to detect the project scope from repository layout signals and manifests. A scaffold is then created from the appropriate template, filling in inferred details like stack and commands while leaving clear placeholders for undetected information.

Yes, you can scaffold a README for a service, library, monorepo, or naisjob. The tool identifies the target scope by looking at signals in the repository layout and manifests, then applies the correct structural specification to produce a template-complete draft.

To fix README drift and keep documentation consistent across project types, you can perform a structural check to ensure required sections are present. This process catches structural anti-patterns and generates a file matching the correct project type, whether it is a service, library, monorepo, or naisjob.

The README scaffold generator does not fill in all details automatically. It fills in what can be inferred from the repository, such as stack, commands, endpoints, and config, but leaves clear {TODO} placeholders where detection is uncertain to ensure accuracy.

You should hand off your README draft to a language-focused tool for clarity polishing after the structural review or generation is complete. This keeps structure responsibility separate from writing quality, ensuring the Norwegian or clarity polishing is applied to a structurally sound document.