Getting Started
Your first project
Allow about ten minutes of your own time — the analysis itself runs in the background.
You need a repository link (GitHub, GitLab or Bitbucket) or the project as a .zip file. It costs credits, deducted while the analysis runs; new accounts receive 40 free credits.
1. Create your account
Open app.dev-doc.io and choose Sign In. Continue with Google or GitHub in one click, or register with your e-mail address and a password — in that case you first receive an activation e-mail.
Want to see results first? Open Demo Projects — fully documented sample projects you can explore without an account.
2. Import your project
- Open Import Project from the home page or the app menu (the grid icon in the top bar).
- Paste a repository link, or choose a zip file. For a private repository, authenticate first — see Import a project.
- Check the pricing model — the quality tier of the documentation and the cost of the run.
- Confirm. The dialog asks whether to include codebase analysis (per-file explanations, off by default) and whether to track the repository for later updates.
You can close the page — the analysis keeps running.
3. Follow the analysis
My Projects shows each project’s status (Waiting, Processing, Completed or Failed) and a progress ring for each part of the documentation. Everything updates live, and you get a message when the run finishes.
4. Read and improve
Click the project name to open it. Generated content is a strong first draft: use Edit to correct it and Approve to mark it as reviewed — approved wording is protected when you re-run the analysis. See Review, edit & approve.
5. Share it and keep it current
Click Share it on any project tab for a public, read-only link. When the code changes, re-analyse from My Projects — an incremental run only fills the gaps. See Keep documentation up to date.