Setting Up Documentation
Select a repo
From Documentation → Get Started, choose the repo you want documented. One repo at a time — run the wizard again for additional repos.
Configure
- AGENTS.md location — type a folder path (e.g.
.for the repo root, orpath/to/folder/), or click Browse... to pick it from your repo's actual file tree instead of typing it blind. - Auto-sync — on by default. Keeps
AGENTS.mdcurrent automatically. - Sync schedule — weekly (default, pick a day: Monday by default) or monthly (pick a day of month, 1–28).
This step only configures the AGENTS.md sync cadence — the wiki itself doesn't need a cadence configured; it updates automatically as PRs merge (see below).
Generate
Kick off generation. Entelligence builds the Overview first, then generates each Section and Subsection — you can watch progress as it completes. Both a Technical Docs wiki and a Tutorial-style walkthrough are generated automatically; you don't need to choose between them up front.
Get notified
Optionally connect Slack and pick a channel to get notified the moment your docs are ready. (The bot needs to already be a member of the channel you want to select — invite it first if you don't see your channel listed.)
Keeping docs current
Once generated, docs update automatically whenever a PR merges into the repo — Entelligence matches the change against existing sections and updates just the affected ones, keeping a version history entry tied to the PR that triggered it.
If a specific section looks off or you want a manual refresh, click Regenerate on that section directly from the docs page — this is self-serve and doesn't require contacting support.
A section that hasn't been touched by an auto-update in over 7 days is flagged as potentially stale — a good signal to trigger a manual refresh.
If an entire repo's documentation fails to generate (rather than a single section looking stale), there's currently no self-serve retry for that — reach out to support@entelligence.ai and we'll re-trigger it for you.
Version history
Every section keeps a timeline of past versions. Each entry shows when it changed, the PR that triggered it (with a link and title, when applicable), and how many files were involved. This is a read-only history for context on why a section reads the way it does today — there's no revert-to-previous-version button, so if an auto-update got something wrong, use Regenerate to produce a fresh version rather than trying to roll back.
Exporting
From any generated doc, use Export → Confluence or Export → Notion. Both require you to have already connected the tool under Connectors — the export modal will tell you to do that first if it can't find a connection.
- Confluence: give the export a title, then pick a parent page from your connected Confluence spaces (or create a new sub-page inline).
- Notion: give the export a title, then pick a parent page from your workspace (you can't export directly to the workspace root — pick or create an actual page).
Troubleshooting
| Symptom | Likely cause | Fix |
|---|---|---|
| A section shows stale/outdated content | No auto-update has touched it in 7+ days | Click Regenerate on that section |
| Export button says it can't find any pages | Confluence/Notion not connected yet | Connect the tool under Connectors, then retry the export |
| Whole-repo generation failed or is stuck | Backend generation error | Contact support@entelligence.ai — this isn't self-serve today |
| Slack channel doesn't show up when picking a notification channel | Bot isn't a member of that channel | Invite the Entelligence bot to the channel, then retry |