nfr-review

What You’ll Find Here

Guided Learning Path

14 chapters take you from first scan to writing custom rules and maintaining the tool. Work through them in order to build deep understanding.

Live Code Samples

Every code example is extracted from the actual source at build time — no hand-copied snippets that drift out of sync with reality.

Rule Catalogue

Interactive, searchable catalogue of every rule nfr-review ships with — severity, category, compliance mappings, and example findings.

Recipes and Reference

Task-oriented recipes for common workflows (monorepo scanning, CI/CD integration, compliance audits) alongside complete CLI and config reference.

How This Site Is Organised

Learn — A sequential training path. Start here. Each chapter builds on the last, from “what does this tool do?” through the full pipeline architecture to writing your own rules and collectors.

Reference — Jump-in, look-up material. CLI flags, config schema, the full rule catalogue, payload field definitions. Use this day-to-day.

Recipes — Task-oriented guides. “I need to scan a monorepo.” “I need to set up baseline tracking.” Step-by-step instructions for specific workflows.

Appendices — Architecture diagrams of nfr-review itself, a glossary of terms, and FAQ.