# Generate docs automatically

Falconer Generate creates a complete set of documentation from your codebase -- so you're not starting from a blank page.

Connect a GitHub repo, define the folder and doc structure you want, and Falconer writes every page for you in the background.

## Prerequisites

- A connected GitHub repository (go to **Settings -> Sources** to connect one)
- Starter plan (1 doc set) or Pro plan (multiple doc sets)

## Start Generate

There are two ways to kick off generation:

- **Quick setup** -- during onboarding, after you connect a GitHub repo, Falconer offers a one-click option to generate a default doc set. Select a repository and click **Generate**. This creates five starter docs (Project overview, Get started, Architecture overview, Contributing guide, and Glossary) inside an Engineering folder.
- **Generate** -- right-click **Company documents** in the left sidebar and choose **Generate documentation**. This opens the full dialog where you can customize the folder structure before generating.

## Build the doc tree

The Generate modal opens with a suggested folder and doc structure. You can customize it before generating:

- **Select a repository** -- use the dropdown in the top-right corner to choose which connected repo Falconer should read from. A green dot means the repo is fully indexed; an orange pulsing dot means indexing is still in progress.
- **Add folders** -- click **Add folder** to create a new top-level folder, or use the folder menu to nest a subfolder.
- **Add docs** -- inside any folder, add a document. Give it a **title** (required) and an optional **description** that tells Falconer what the doc should cover.
- **Rename or delete** -- click any folder or doc name to edit it. Delete items you don't need.

The modal footer shows a running count of documents against the per-generation limit. Every folder must contain at least one document, and every document needs a title.

### Default doc set

If you don't customize, Falconer starts with these five docs under an **Engineering** folder:

| Document | Description |
| --- | --- |
| **Project overview** | What the project does, why it exists, and who it's for |
| **Get started** | Step-by-step setup: prerequisites, installation, environment config, first local run |
| **Architecture overview** | System structure, major components, data flow, tech stack, key design decisions |
| **Contributing guide** | Contributor workflow, PR expectations, branching conventions, coding standards |
| **Glossary** | Domain-specific terms, acronyms, and project jargon |

You can add, remove, or rename any of these before generating.

## Generate

Click **Generate** to start. Falconer verifies the repository is indexed, then generates each document in the background by inspecting your actual codebase with code search. A progress overlay tracks how many docs have been created.

Once generation completes, the new docs appear in your sidebar under the folder structure you defined.

## FAQ

**Is this for onboarding or can I use this to generate any doc set?**

Both. This is a great way to start with a high-quality doc set with nothing but a codebase. It's also great when you create a new service, feature, or product and want to generate docs for it.

**Can I customize the auto-generated docs?**

Yes, in a couple of ways. You can define the docs structure before generating the docs. And you can edit them after they're published.