Generate a per-file reference

Codebase Documentation creates a separate document for each selected source file and groups the results into a new Space. Choose it when your goal is file-level reference material.

For an architecture- and task-organized documentation set, use Full Tree Documentation.

Select the source

Open Codebase Documentation from the repository tools, choose the repository and branch, and synchronize the codebase if the flow requires it. In the file tree, select the source files that deserve individual documentation.

Exclude dependency directories, binaries and compiled output. Selecting more files increases the amount of work and can create a less useful reference if the files are repetitive or incidental.

Generate and review

Add instructions describing the reader and the details each document should explain, then start generation. The new Space contains the per-file pages; follow their progress before treating the run as complete.

Review a representative file's documented responsibilities, parameters, return values and relationships against its source. Where understanding depends on multiple components, add an overview that links those pages together.

Use the result

Organize the pages into folders, add explanatory introductions and use exports when you need a deliverable. Source changes do not automatically regenerate this reference unless you configure an appropriate update workflow.

If the repository is absent, return to Git Connections and verify its import status. A provider authorization without an imported repository is not enough for an imported-file picker.