Generating a Wiki
Generate structured documentation for any connected GitHub repository.
Generate a full wiki for any connected GitHub repository in a few clicks. Paragon's agent clones the repo, analyzes the codebase, and produces structured, multi-page documentation.
Creating a Wiki
- Navigate to Wiki in the top navigation
- Click Add Repository
- Search for and select a connected GitHub repository
- Click Generate — you'll be redirected to the wiki viewer
The repository must be connected to your Paragon account. If you don't see it in the list, connect it first in Settings > Repos.
Generation Process
Once you submit a repository, the generation process begins:
| Stage | What Happens |
|---|---|
| Pending | Wiki record is created and the agent session is initialized |
| Generating | The agent clones the repo, analyzes source files, and builds documentation page by page |
| Completed | The wiki is ready to browse with a full topic tree and all pages populated |
| Failed | Something went wrong — you can retry by regenerating |
Generation typically takes a few minutes depending on repository size. A loading indicator shows progress while the wiki is being built.
What Gets Analyzed
The agent examines your repository's:
- Source code — Functions, classes, modules, and their relationships
- Project structure — Directory organization, entry points, and configuration files
- Dependencies — Package manifests and how modules depend on each other
- Documentation — Existing READMEs, inline comments, and docstrings
Generated Output
Each wiki includes:
- Overview page — High-level summary of the repository's purpose and architecture
- Topic pages — Grouped by theme (e.g., API endpoints, data models, UI components, configuration)
- Source file references — Each page lists the files that informed its content
- Headings index — Used for the table of contents and in-page navigation
Tips
- Larger repos take longer — A small utility library may finish in under a minute; a monorepo may take several minutes
- Public and private repos — Both work as long as they're connected to your account
- Branch context — The wiki is generated from the repository's default branch at the current HEAD commit
- Git SHA tracking — Each wiki records the commit SHA it was generated from, so you know exactly what version the docs reflect