AI generation
Connect a repository
Pick a repo, a branch, and the folders that matter.
Open Settings → GitHub and connect your GitHub account. You only do this once; every doc space can then read from any repo the account can see.
Pick what to read#
In a doc space's settings, under GitHub & AI, choose a repository, a branch, and the paths worth documenting:
src/for entry points, routes and modulesREADME.mdfor the overview you already wrotedocs/for anything you've drafted by hand
The branch and paths are saved with the doc space, so the next run reads the same slice of the repo.
What gets read#
| Included | Skipped |
|---|---|
| Source files in the selected paths | node_modules and build output |
| README and other Markdown | Lock files |
| Config that documents behaviour | Images and other binaries |
DocSpell reads your source as text, so the language doesn't matter. TypeScript, Python, Go, Rust: it all works. It does best when the code has sensible module boundaries and at least a short README.
What DocSpell keeps#
Files are fetched from GitHub while a generation runs and sent to the AI model that writes your pages. DocSpell stores the pages it writes, not your source code.
Last updated Oct 5, 2026