Docs Health

Docs Health is the bird's-eye view of your documentation. While document insights and Scan with AI focus on one page at a time, the Docs Health board (/health) aggregates issues across an entire project so you can see where your docs are strong, where they're slipping, and what to fix first.

Opening the board

Open Docs Health at /health from the app sidebar. Use the project filter (defaults to All projects) to focus on one project, or search to find specific issues.

The overall health score

At the top, an Overall health score summarizes the project's documentation health in a single number, so you can set a team target and track it over time. The This week rail on the side shows the momentum behind it:

• Issues created — new problems detected this week.
• Issues resolved — problems fixed this week.
• Health score change — net movement in the score.

Prioritized issues

The core of the board is the Prioritized issues queue — a ranked list of concrete, fixable problems. Each row shows:

Typical issues include broken internal links, missing image alt text, pages that have dropped below your quality bar, and pages past their review cadence. Many of these overlap with what dxb lint reports from the CLI — Docs Health is the always-on, in-app view.

Triaging issues

Docs Health is built to drive action, not just display numbers. From a single issue's menu you can:

• View details — open the issue drawer for the full context.
• Assign to me — take ownership of the fix.
• Mark resolved — close it once fixed.
• Dismiss — drop it if it's not worth acting on.

Select several issues to act in bulk with Assign to me, Resolve, or Dismiss, then Clear the selection.

The issue drawer

View details opens a drawer with everything about an issue — the affected page, the specific problem, and a path to the fix — so you can resolve it without losing your place in the queue.

Automating with the agent

The most powerful way to use Docs Health is to pair it with the AI agent. Schedule agent tasks to:

• Run a weekly QA audit and route low-scoring pages into review.
• Run a Link check to catch broken links automatically.
• Run a monthly Freshness task to flag stale pages to their owners.

This turns Docs Health from a dashboard you remember to check into a system that maintains itself.

Docs Health vs. analytics

These answer different questions:

• Docs Health — Is the content good and current? (quality, freshness, structure)
• Analytics — How are readers using it? (traffic, search, AI questions, feedback)

Read them together: analytics tells you which pages matter most to readers, and Docs Health tells you which of those need attention.

Next steps