docs-audit

What problem does it solve?

Identify gaps between a Rails application's code and its documentation site so teams know which controllers, models, and routes lack user-facing pages and require documentation.

Core Features & Use Cases

• Resource inventory: Runs or instructs a script to list controllers, models, routes, and existing doc pages to create a baseline.
• Gap classification: Categorizes missing documentation by priority (high/medium/low) based on user impact and feature type.
• Actionable report: Produces a prioritized checklist and suggested doc paths so maintainers can approve and start creating pages.
• Use case: Quickly audit a Rails app before a release to surface undocumented end-user features and prioritize doc work.

Quick Start

Run the docs-audit workflow on the Rails project root to generate a prioritized documentation gaps report.