Docs Audit

Docs Audit runs your Linter rules against every page in your project in a single pass, so you can find outdated content, broken links, and style inconsistencies across your entire site without reading every page yourself. Results are organized by page and scored against your existing rules — no separate setup. Click into any page to see specific issues, then fix them in the editor or with the Agent. Enterprise customers can schedule recurring audits and export results as CSV.

Getting Started

1. Open your project in ReadMe.
2. Go to Docs Audit.
3. Click Run Audit.
4. Review results by page. Click into any page to see issues.
5. Fix issues in the editor — the Linter gives real-time feedback as you edit.

What results look like

When you run an audit, you get a scored list of every page in your project. Each page shows how it performed against your style guide, how many errors and warnings it has, and whether it contains broken links.

For example, an audit might reveal that:

• Your "Authentication" guide scores 92% on style but has 3 broken links to endpoints you renamed last month.
• Your "Quickstart" page has 0 errors but 7 warnings for passive voice and hedging language.
• 12 pages across your site still reference your old product name after a rebrand.
• Your API Reference pages are clean, but your tutorial section has inconsistent heading styles.

Click into any page to see the specific issues. From there, you can edit directly in the editor (where the Linter gives real-time feedback) or use the Agent to fix issues automatically.

Enterprise customers can schedule audits to run weekly or monthly and export results as CSV for team review.

FAQ