Skip to main content

Coverage dashboard

Route/authoring/scribe/dashboard PreviewScribe previewscribe

The Scribe dashboard — "Documentation health measured from every project's catalog…" — is the tenant-wide view: how much of each project's most recent published version is documented, and the quick actions that fill the gaps.

Coverage cards​

CardReadsLink
Overall CoveragePaths and schemas with documentation, across projectsOpen the readiness work queue
Paths DocumentedPaths with a summary or descriptionDocument undocumented paths
Schemas DocumentedClasses with a description—
Stale Alerts"Documented paths not reviewed in over 90 days." — measured from the catalogReview stale documentation

Trends are marked unavailable — "Trends need stored coverage snapshots from the coverage engine." — and Recent AI Activity is planned.

Quick actions​

Auto-fill missing path summaries and Document undocumented schemas run on the version selected in the header. With none: "Select a project and version above to auto-fill its documentation. You can still review stale alerts." The stale-alerts link reads Review N stale alerts or Review stale alerts — none pending, from a live count.

A run builds the version's OpenAPI document, starts a bulk job on the Suite's LLM gateway, polls it ("Generated X of Y"), and re-measures when it finishes. The result is a toast: "Auto-filled N …", "Generated X of Y …", "Stopped after X of Y", "No documentation was generated" or "Nothing to generate". A job needs an API key saved in Settings; it runs for at most about ten minutes before the dashboard stops waiting, and it can be cancelled.

note

Bulk generation writes to Spire's documentation content, while the dashboard measures the Designer catalog. If the figures do not move after a run, open the content workspace to see what was written and save it to the catalog.

Project Coverage​

A table — Project, Version, Paths, Schemas, Score, Actions — with one row per project, measured on its most recent published version, and Auto-fill all gaps per row. Empty states: "No projects yet. Create a project in the Designer…" and "No versions yet — nothing to measure."