Home CodeDoc Where can I see documentation coverage and key metrics?

Where can I see documentation coverage and key metrics?

Last updated on Nov 10, 2025

Short Answer: Open the Overview tab and review the "Documentation analytics" card: the donut (Documentation coverage) and stat tiles (Total files, Documented, Undocumented, Documented this month).

Prerequisites

  1. At least one documentation run completed

  2. Repository(ies) connected to CodeDoc

Steps

  1. Open the CodeDoc page and select the Overview tab.
    You see the Overview content including analytics panels.

  2. Scroll to the "Documentation analytics" section.
    You see the "Documentation coverage" donut chart and the stat tiles.

  3. Use the Repository / Branch dropdowns (top-right of analytics) to filter the metrics to a specific repo or branch.
    Analytics update to reflect the selected repository/branch.

Troubleshooting

  1. Coverage shows 0% or values look empty.
    LikelyCause: No documentation runs have been completed for the selected repo/branch.
    Action: Run documentation for the repository or select a different branch; verify runs in Usage.

  2. Metrics differ from repo expectation.
    LikelyCause: A filter (Repository/Branch) is applied or stats are cached.
    Action: Clear filters or select the desired repo/branch, then refresh the page to reload analytics.

Note: The donut shows percentage covered; the stat tiles show raw counts for quick inspection.