Repo Docs
Open the app: Document a repository → (products.documentize.ai)
In one sentence
Repo Docs reads a GitHub repository, writes a documentation site for it (overview, architecture, projects, API reference, diagrams and more), and delivers it as a pull request plus a zip download.
What makes it unique
- It is grounded in your code. The code is indexed first, then AI explains it. Every type or member name the AI writes is checked against that index; names that do not exist are corrected or removed, and a quality report lists what was checked.
- It ends in a pull request, not just a file. The pull request changes only generated files; hand-written docs are never touched.
- It can be resumed. A run that hits the time limit keeps what it finished, and Continue picks up the rest.
When to use it / when not to
- Use it to give a repository a first real documentation set, to refresh docs after a big change, or to onboard new contributors.
- Not for a queryable data model of the code → Code Graph.
- Not for one compiled library you cannot see the source of → Assembly Chat.
- Not for languages outside the list. Supported: .NET (C#), TypeScript, Python, Java and Go. Other files are not documented.
Before you start
- A GitHub repository, as
owner/nameor a URL (a/tree/<branch>URL selects that branch). - Private repository? Invite the
arise-projectGitHub account as a collaborator; the pull request then goes straight to your repository. Without that, the page says the pull request opens inarise-project's own fork (this only works for repositories it can read; for a private repository you need the invitation). - Privacy: the repository is copied into a temporary folder for the run and deleted afterwards. The AI explanations of a repository are cached to make later runs faster; the page says the code itself is not kept. Code excerpts are sent to a language model to write explanations, so do not run it on code you are not allowed to share with that service.
Step by step
- Enter the GitHub repository and, if needed, the Branch.
- Choose the Sections, Audience and Detail level (see below). For a .NET solution with several, enter the Solution path.
- Set Output language and the Docs folder if you do not want
docs. - Start the run. The pull request opens early as a draft (its link shows within minutes) and is updated as the run progresses.
- When the run ends, open the pull request, or download the zip. If the result says the docs are partial, press Continue documentation.
- Your runs are listed under "Your repositories" (saved in this browser), where you can follow, Run again or remove them.
Options explained
| Option | What it does | Default | Recommended |
|---|---|---|---|
| Solution (.NET only) | A .sln, .slnx or .csproj inside the repository to document | found automatically | Set it when the repo has several solutions |
| Sections | Overview, Architecture, Projects, Features, API reference, Diagrams (on); Examples, Glossary (off) | six on | Add Examples and Glossary for public libraries |
| Audience | New contributors, API users, or Both | Both | Pick one to shorten the result |
| Detail level | Brief, Standard, Thorough | Standard | Brief for a first look |
| Output language | Default (English), or one of de, fr, es, it, pt, nl, pl, ru, uk, tr, ar, hi, ja, ko, zh | English | Match your readers |
| Docs folder | Repository folder the docs go into (not inside .git or .github) | docs | Keep the default |
| Full member signatures | Shows complete signatures in the API reference | on | Keep on |
| Include internal types | Documents internal types too | off | Only for contributor docs |
| Improve the README | Proposes a better README as its own separate commit | off | Try it; drop the commit if you dislike it |
If your docs folder already holds hand-written pages, the generated docs go into a repodocs subfolder instead, so nothing of yours is in the way.
What you get
- A pull request by
arise-project(draft while partial, marked ready for review at full coverage). Older docs pull requests for earlier commits are closed with a link to the new one. - A zip with Markdown pages, an MkDocs configuration (a DocFX configuration is also mentioned on the page), an HTML site and a PDF. Diagrams are Mermaid: project dependencies, component families and dependency-injection registrations.
- A result panel: pages planned and finished, how many AI explanations were written, broken links, and the pull request status.
Quality & limits
- AI-written text on top of an exact code index. Everything is built from one commit, and the page shows which.
- A free run stops after 15 minutes with what it finished; a paid plan finishes the documentation in one run.
- Continue runs are not metered: the code treats a Continue as unbilled, and it must continue a real earlier run of the same repository. The page text says Continue finishes the rest at no cost.
- The code is never built or run.
Works well with
- Before: Code Graph for the structural map; NuGet Updater to keep dependencies fresh.
- After: a MkDocs or GitHub Pages deployment of the pull request's output.
- Related: Trust, verification and limits of AI output.
Common mistakes & fixes
- The pull request is a draft → the docs are partial; press Continue.
- No pull request but a zip → delivery failed (for example no access). The zip holds the same docs.
- "Select at least one section" → tick at least one.
- Docs folder rejected → it must be a relative path inside the repository.
- Wrong solution documented → set Solution explicitly.
Same thing elsewhere
Not verified for this app. See channels.
Try it
Run Repo Docs on a small public repository with Detail level Brief, only the Overview and Architecture sections, and the default folder. Open the draft pull request when its link appears, read the architecture page, and check one class name it mentions against the code.