Home CodeDoc

CodeDoc

AI-powered code documentation for faster onboarding, reviews, and understanding.
By Vishwesh
• 37 articles

How do I connect my GitHub account to Generate documentation?

Short Answer: Open 'Generate documentation', choose a connection method and click 'Connect GitHub' to authorize access to your repositories. Prerequisites 1. A GitHub account 2. Access to the repository you want to document 3. Organization owner or admin access to install the GitHub App (Recommended) (if using 'GitHub App (Recommended)') Steps 1. Open the Generate documentation page. You see the 'Generate documentation' panel with 'Connect to GitHub' options. 2. Under 'Connect to GitHub' select 'GitHub App (Recommended)' or 'GitHub OAuth'. Your chosen method is highlighted. 3. Click 'Connect GitHub'. A GitHub authorization window or redirect opens. 4. Complete the GitHub authorization (accept the requested permissions). GitHub account is connected and you return to 'Choose repository and branch'. 5. Select 'GitHub account', 'Repository' and 'Branch', then click 'Continue'. You move to the 'Select files to document' step. Troubleshooting 1. 'GitHub account' or repositories do not appear in the dropdown. LikelyCause: GitHub authorization was not completed or you signed in to a different GitHub account. Action: Click 'Connect GitHub' again and complete the authorization using the intended GitHub account. 2. You can't install the GitHub App (organization install blocked). LikelyCause: You are not an organization owner or admin required to install the app to an org. Action: Use 'GitHub OAuth' for repo-level access or ask an org owner/admin to install 'GitHub App (Recommended)'. Note: Use 'GitHub App (Recommended)' for org installations and 'GitHub OAuth' for personal or repo-level access.

Last updated on Nov 10, 2025

How do I pick specific files to document using 'Pick my own files'?

Short Answer: Choose 'Pick my own files', expand the file tree or use 'Search files...' to check files, confirm the summary, then click 'Generate documentation'. Prerequisites 1. Repository and branch selected 2. GitHub account connected Steps 1. On the 'Select files to document' page open the 'Choose files to document' dropdown and select 'Pick my own files'. A file tree and 'Search files...' field appear. 2. Expand folders in the file tree and check the boxes for files you want to document. Checked files are highlighted in the list. 3. Use 'Search files...' to filter by filename if needed. The file list shows matching results only. 4. Review the selection summary at the bottom (e.g., '12 files selected • 32 units • Free left: 50/50 • Estimated cost: $3.20'). You can see the selected file count and estimated cost. 5. Click 'Generate documentation'. Generation starts or a 'Review files' modal appears if AI flagged files. Troubleshooting 1. Message 'No files available for this repo/branch under the selected filter.' LikelyCause: The current branch or filter excludes files. Action: Change the 'Choose files to document' filter (for example select 'All files in the repository') or switch branch under 'Choose repository and branch'. 2. Files you expect are skipped after generation. LikelyCause: AI flagged those files as not relevant and they were not included in the 'Review files' modal. Action: When the 'Review files' modal appears, check the files you want and click 'Include selected files'. Note: Estimated cost updates as you change selections; watch the bottom summary before generating.

Last updated on Nov 10, 2025

What should I do when I see the 'Low balance' modal?

Short Answer: Either click 'Reduce selected files' to lower cost or click 'Add $X credits' to top up; the modal shows 'Estimated cost', 'Current balance', and 'Credit required'. Prerequisites 1. You attempted to generate documentation and your account balance is insufficient Steps 1. Read the 'Low balance' modal which shows 'Estimated cost', 'Current balance', and 'Credit required'. You know how much credit is required to continue. 2. To lower cost click 'Reduce selected files' to return to file selection and deselect files. You can adjust selected files to reduce the estimated cost. 3. To add credits click the 'Add $X credits' button (label shows required amount). The billing form opens. 4. Complete the billing details form and confirm currency conversion if shown, then click 'Continue' to finalize the top-up. Credits are added and you can re-run generation. Troubleshooting 1. Modal shows a 'Minimum top-up required' amount. LikelyCause: The system enforces a minimum credit top-up for this transaction. Action: Add at least the minimum required amount or reduce your selected files until the required credit is within your balance. 2. I added credits but my balance didn't update immediately. LikelyCause: Payment processing or network delay. Action: Wait a minute and refresh the page; if it persists check Billing settings or contact support. Note: Buttons shown exactly as 'Reduce selected files' and 'Add $X credits' (X varies per case).

Last updated on Nov 10, 2025

How do I share repository documentation and set it to Public or Private?

Short Answer: Click the 'Share' button, in 'Share documentation' enter emails and choose roles, pick 'Private' or 'Public' under 'Document access', then click 'Save' (or 'Copy link'). Prerequisites 1. You have access to the repository view (Share button visible) 2. You know the teammate emails to add Steps 1. Click 'Share' in the top-right of the repo header. 'Share documentation' modal opens. 2. Type one or more emails into the input under 'Share with your team' and select a role from the 'Member' dropdown for each email. New people appear in 'People with access' with the selected role. 3. Under 'Document access' choose 'Private' or 'Public' (note description: 'Only team members can view this documentation.' or 'Anyone with the link can view. No login required.'). [screen_4.png] Document access selection is set. 4. Click 'Save' to apply sharing changes, or click 'Copy link' to copy the shareable URL. [screen_4.png] Changes saved and modal closes (or link copied to clipboard). Troubleshooting 1. Unable to set access to 'Public' or 'Save' fails. LikelyCause: You may not have permission to change visibility (role restrictions — Owner/Admin may be required). Action: Ask the repository Owner/Admin to change access or add the desired users/visibility for you. 2. 'Copy link' does not place the URL in your clipboard. LikelyCause: Browser blocked clipboard access. Action: Allow clipboard access in your browser or manually copy the URL from the address bar after selecting 'Public'. Note: The modal lists 'People with access' and their role (Admin, Member, Owner) so you can confirm who already has access before saving.

Last updated on Nov 10, 2025

How do I add an automation to run documentation automatically?

Short Answer: Open the Automation tab, click "Add automation", complete the automation dialog, and save; the new automation will appear in the automations list. Prerequisites 1. Repository and branch connected in CodeDoc 2. Permission to create automations Steps 1. Go to the Automation tab in CodeDoc. Automation list and controls are visible. 2. Click the "Add automation" button to open the automation dialog. The "Add automation" dialog appears. 3. Complete the required fields in the dialog (select repository, branch and define the trigger/conditions shown). All required fields are filled and the primary save button becomes active. 4. Click the dialog’s primary button to save the automation. The new automation appears in the automation list and can be toggled ON/OFF. Troubleshooting 1. "Add automation" button is unresponsive or the dialog save button is disabled. LikelyCause: Required fields are missing or you lack permission to create automations. Action: Fill all required fields in the dialog and check your account permissions; contact an Admin/Owner if needed. 2. Automation does not trigger as expected. LikelyCause: Automation toggle may be OFF, or trigger/conditions target a branch with no new activity. Action: Open Automation tab, ensure the automation is toggled ON and verify trigger settings and target branch. Note: Automation UI shows the trigger/condition configuration in the dialog; saved automations can be edited from the Automation list.

Last updated on Nov 10, 2025

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.

Last updated on Nov 10, 2025

How do I view documentation run history and open the file-level details for a run?

Short Answer: Open the Usage tab, locate the run row and click the run’s “View detail” action to open the “Files documented” modal that lists file names, modules, tags, and sizes. Prerequisites 1. At least one documentation run in Usage 2. Permission to view run details Steps 1. Open the Usage tab in CodeDoc. A table listing documentation runs is visible. 2. Use the top filters (Repository, Search, Date) to narrow the runs if needed. The table displays matching runs. 3. Find the run you want and click the run’s “View detail” icon in the right-most column. A “Files documented” modal opens showing documented files for that run. 4. Review the columns in the modal: “File name”, “Module”, “Tags”, “Size” and click “Close” when finished. You see file-level details and can close the dialog to return to Usage. Troubleshooting 1. “No documentation runs yet” message appears. LikelyCause: No documentation runs have been executed for this workspace. Action: Run documentation via “Generate documentation” or set up Automation to create runs. 2. “View detail” icon is not present or disabled. LikelyCause: You may not have permission to view run details or the run is still processing. Action: Check Settings → Documentation settings for permissions and wait for the run to finish. Note: The “Files documented” modal shows file-level output for the selected run; use it to validate which files were processed.

Last updated on Nov 10, 2025

How do I view the repository list and per-repo coverage in the Documentation tab?

Short Answer: Open the Documentation tab to see a table of repositories with columns: Repository, Branch, Files documented, Coverage, Last documented, and Action. Prerequisites 1. Repositories connected to CodeDoc 2. At least one documentation run for the repository to show coverage Steps 1. Go to the Documentation tab in CodeDoc. A table of repositories is displayed. 2. Scan the table columns: "Repository", "Branch", "Files documented", "Coverage", "Last documented", "Action" to find the repo/branch you need. You can read the documented/total files and coverage bar for each repo. 3. Use the Action icon in the row to open repository-specific options or to run/view documentation for that repo. An action menu or run is initiated for the selected repository. 4. If you don't see a repository, use the pagination controls at the bottom of the table to move between pages. You can navigate to additional repository rows. Troubleshooting 1. Repository is not listed in Documentation. LikelyCause: Repository not connected or filters/pagination hiding it. Action: Confirm the repository is connected and check pagination; search or change page to locate it. 2. Action icon does nothing or is missing. LikelyCause: You may lack permission to run/view documentation for that repo. Action: Check Settings → Documentation settings and request appropriate permissions from an Admin/Owner. Note: The "Files documented" column uses the format documented / total (e.g., "420 / 620").

Last updated on Nov 10, 2025

Who can run documentation and how do I change that setting?

Short Answer: Open Settings → Documentation settings and update “Who can run documentation” checkboxes (Anyone (members), Admins, Owners), then click “Save changes.” Prerequisites 1. You must have permission to edit CodeDoc settings (Admin/Owner role may be required) Steps 1. Open the CodeDoc page and select the Settings tab. The Settings view for CodeDoc is displayed. 2. Under “Documentation settings,” find “Who can run documentation.” Checkboxes for “Anyone (members),” “Admins,” and “Owners” are visible. 3. Check or uncheck the boxes to grant or restrict run permissions. Your selection reflects who can run documentation. 4. Click the blue “Save changes” button to apply the updated permissions. Settings are saved and take effect for subsequent documentation runs. Troubleshooting 1. I cannot change the checkboxes or “Save changes” is disabled. LikelyCause: You do not have the required account role to edit these settings. Action: Ask an Admin/Owner in your organization to update the setting, or sign in with an account that has permission. 2. Users still cannot run documentation after changes. LikelyCause: Permissions may take a few moments to propagate, or the user is outside affected scope. Action: Have affected users sign out/in again; confirm the correct boxes were checked and the correct repository/branch is targeted. Note: The page includes an information (ⓘ) icon next to the heading to clarify behavior; hover or click it to view the tooltip if available.

Last updated on Nov 10, 2025

Why does the Documentation or Usage page show empty states like "Your documentation is empty" or "No documentation runs yet"?

Short Answer: Those messages appear when no documentation has been generated or when no runs exist for the selected repo/filters; connect repos and run documentation or remove filters. Answer PreRequisites 1. Access to the CodeDoc workspace 2. Connected repository (if expecting results) Steps 1. Open the Documentation and Usage tabs to confirm the empty-state message. You see either "Your documentation is empty" (Documentation) or "No documentation runs yet" (Usage). 2. Check that repositories are connected to CodeDoc (Overview empty-state messaging indicates this) and that you have permission to run documentation. You confirm whether a connection or permission is missing. 3. If no runs exist, click "Generate documentation" or set up an Automation to create runs. A documentation run is created and will appear in Usage when complete. 4. If results still do not appear, clear any filters (Repository, Date, Search) on the Usage/Documentation pages and refresh the page. Any hidden results should appear if they match the cleared filter criteria. Troubleshooting 1. I ran documentation but still see the empty state. LikelyCause: Run may have targeted a different branch, is still processing, or failed. Action: Open Usage to confirm the run status and which branch/repository it targeted; rerun if necessary. 2. Repositories should be present but are not listed. LikelyCause: Repository integration was not completed or required permissions not granted. Action: Reconnect the repository integration and ensure the app has permission to read the repository. Note: Empty-state text provides the next step (e.g., connect repository or run documentation); follow that guidance first.

Last updated on Nov 10, 2025