Reporting & Analytics
Use these active reports to monitor docs health, guide coverage, user feedback, and repo maintenance.
Active reports
Section titled “Active reports”| Report | What it answers | Updated by |
|---|---|---|
| Alarm Coverage Index | Which alarms have troubleshooting guide coverage? | Refresh generated data workflow and site builds, via generate-coverage-index.mjs |
| Open Suggestions | Which guides have unresolved user feedback? | Event-driven Refresh topic issues workflow, with an hourly fallback, via generate-topic-issues-index.mjs |
| Open Pull Requests | Which docs PRs are waiting for review or merge? | Refresh generated data workflow, via generate-topic-prs-index.mjs |
| Guide Traffic and Effectiveness Report | Which guides are viewed most often, and how does that traffic compare with reader effectiveness responses? | Guide view events and reader responses via /api/guide-page-views and /api/topic-feedback |
| Downloadable Reports | Which reporting and analytics CSV exports are available, what does each report contain, and how current is it? | Each report’s existing refresh process |