Using Dev-Doc
Keep documentation up to date
Documentation is only useful while it matches the code. There are two ways to update a project.
Re-analyse
On My Projects, each card has a Reanalyse line: click the mode to switch between incremental and complete, then the play button.
| Incremental | Complete | |
|---|---|---|
| What it does | Keeps the existing analysis and fills the gaps | Rebuilds the analysis and regenerates the documentation |
| Cost | Only the missing work | The whole project again |
| Use it when | A run stopped or failed part-way, or you now want codebase analysis too | You switched to a higher pricing model, or want everything fresh |
| Your edits | Untouched | You choose which to keep |
Re-analysing uses the code you imported; it does not download the repository again.
Track a repository
Turn tracking on in the import dialog, or later with Connect repository on the project card. The card then offers:
- Refresh documentation — downloads the latest commit and updates the documentation incrementally.
- Check for updates — asks whether newer commits exist.
- Edit connection — change the address, branch or access token.
- Disconnect — stop tracking; the documentation stays.
If the repository has no new commits since the last run, a refresh is skipped and costs nothing.