Keep documentation up to date

Documentation is only useful while it matches the code. dev-doc gives you two ways to update a project: re-analyse the copy you imported, or refresh from the repository when it is tracked.

Re-analyse a project

On My Projects, each card has a Reanalyse line with a mode and a play button.

  1. Pick the modeClick the word incremental or complete to switch between them.
  2. Click the play buttonA confirmation dialog states the mode, and asks again whether to include codebase analysis (your previous choice is pre-selected).
  3. ConfirmThe run starts; follow it on the card.
IncrementalComplete
What it doesKeeps the existing analysis and fills the gaps.Rebuilds the analysis and regenerates the documentation.
CostOnly for the work that is missing.The whole project is billed again.
Use it whenA run was stopped or failed part-way, or you now want codebase analysis too.You switched to a higher pricing model, or want everything written fresh.
Your editsUntouched.You choose which approved/edited sections to keep.
Re-analysing uses the code you imported. It does not download your repository again. To document newer commits, use Refresh documentation on a tracked repository (below), or import the project again.

Track a repository

Tracking links a project to its repository, so you can bring the documentation up to date with new commits in one click. Turn it on in the import confirmation dialog (Track this repository for updates), or later with Connect repository on the project's card.

When a repository is connected, the card offers:

On a project shared with you through a workgroup, the card shows the same status and Check for updates. Refresh documentation needs the Run & stop analyses right, and only the owner can connect, edit or disconnect the repository.

Already up to date? If the repository has no new commits since the last run, a refresh is skipped and costs nothing.

What to do next