Home CodeDoc How do I open a file's documentation?

How do I open a file's documentation?

Last updated on Nov 10, 2025

Short Answer: Click a filename in the left file tree (or use 'Search files') — the main pane opens with the breadcrumb, file title, 'File summary' and the code preview.

Prerequisites

  1. Repository is open (example: Data-Recon)

  2. You can view the current branch (header shows 'Branch: main')

Steps

  1. In the left sidebar expand folders under 'Data-Recon' to find the file you want (for example 'datarecon.js').
    The filename is visible in the file tree.

  2. Click the filename (for example 'datarecon.js').
    The main pane shows breadcrumb 'Data-Recon / Action / datarecon.js' and the page title 'datarecon.js'.

  3. Read the 'File summary' box and the code preview on the right to inspect documentation and sample code.
    'File summary' content and the code viewer are visible.

Troubleshooting

  1. Clicking a file opens a blank area or shows 'Documentation in progress'.
    LikelyCause: Documentation generation (indexing) is still running — header shows 'Documenting X of Y files...'.
    Action: Wait for the background processing to finish, then refresh the page. Try opening a different file that already has a 'Last documented' time.

Note: The file tree and file pages update as documentation is generated; documented files show a 'Last documented' timestamp in lists.