Using Dev-Doc

Import a project

Every documentation project starts with an import: point Dev-Doc at a repository on GitHub, GitLab or Bitbucket, or upload your project as a zip file.

From a repository

1. Paste the address, e.g. https://github.com/owner/repository. The host is recognised automatically.
2. Check the pricing model and change it if needed.
3. Click Import Project and confirm.

From a zip file

Choose a .zip of your project’s root folder and click Upload Project. Leave out build output, installed dependencies and large media — they slow the import down and are skipped anyway — and make sure the zip opens on your own computer first.

The confirmation dialog

• Include codebase analysis — adds plain-language explanations for every file, class and function. Off by default; it adds time and cost.
• Track this repository for updates — links the project to its repository so you can later Refresh documentation against new commits.
• Import into workgroup — when you belong to a workgroup, share the new project with it straight away. You stay the owner and the import is billed to you.

Private repositories

Dev-Doc needs read access:

1. Create an access token — on GitHub a personal access token with the repo scope, on GitLab a personal access token, on Bitbucket an app password. Read access is enough.
2. Paste the repository URL; a 🔒 Authentication button appears.
3. Enter the token (plus your username for GitHub and Bitbucket). Dev-Doc checks it immediately; the lock turns green when accepted.

If a token expires later, update it with Edit connection on the project card instead of importing again.