How do I generate documentation for a repository?

Short Answer: Open CodeDoc and click the blue "Generate documentation" button (or use the repository Action icon) to start a documentation run; view results in Usage or Overview.

Prerequisites

1. Be signed in to Everdone

2. A repository connected to CodeDoc (see Overview empty state)

3. Permission to run documentation (check Settings → Documentation settings)

Steps

1. Open the CodeDoc page and go to the Overview or Documentation tab.
   You see the CodeDoc header and the blue "Generate documentation" button.

2. Click the blue "Generate documentation" button (top-right) to start a run for the selected repository or project.
   A documentation run is started (UI may show progress or create a new run entry).

3. Alternatively, in the Documentation table locate the repository row and use the icon in the "Action" column to run or manage documentation for that repository.
   The repository-specific action triggers a run or opens options for that repo.

4. Open the Usage tab to view the run entry and click the run’s "View detail" action to inspect which files were documented.
   The run appears in Usage and a "Files documented" dialog shows file-level details.

Troubleshooting

1. "No repositories connected yet" appears instead of repositories.
   LikelyCause: No repository has been connected to CodeDoc for this workspace.
   Action: Connect your repository (the empty state message prompts connection). After connecting, retry "Generate documentation".

2. "Generate documentation" does not start a run or seems unresponsive.
   LikelyCause: You may not have permission to run documentation or a browser popup/authorization was blocked.
   Action: Check Settings → Documentation settings to confirm you have permission. Allow any OAuth popups and reload the page.

3. A run completed but coverage/counts didn’t update.
   LikelyCause: Run may still be processing, failed, or targeted a different branch than you expected.
   Action: Open Usage to confirm run status; if failed, re-run or check which branch/repository was targeted.

Note: If you manage many repositories, use the repository-specific Action icon to target a single repo instead of generating docs globally.