# Atlas

> Generate a cited guide to an indexed repository, ask questions inside it, and rebuild it when the code changes.

Atlas turns an indexed repository into a guide your team can read. It gives you a page tree, an outline for each page, and links to the source files behind the writing. Source links open at the commit the Atlas describes, so they continue to point at the code you read even after the branch moves.

Use Atlas to onboard onto an unfamiliar repository, explain a subsystem to a teammate, or answer a question without assembling the relevant files yourself. Memories about the code appear alongside the pages they concern.

*Interactive Atlas walkthrough available on this page.*

**Note:**
An accepted generation job or a ready outline is not a published page. Follow the job's result and published-page count before treating new writing as available. A refusal or incomplete job remains incomplete. The interactive example below uses public demo data; it is not a receipt that generation succeeded for your repository.

## Generate your first Atlas

You need an indexed repository first. Connect one through [GitHub](https://docs.fatelabs.ca/github) or run `estelle sweep` from a local checkout.

### Choose the repository

Open **Atlas**. If this repository has no Atlas yet, the generator opens automatically; otherwise choose **New Atlas**. The repository list marks each indexed repository **Has Atlas** or **No Atlas**.

### Approve the outline job

Choose **Generate Atlas**. Review the repository, source commit, funding, and job limits in the confirmation. If Estelle Credits fund the job, set a **Credit ceiling**. Tick **I approve these limits and uncapped input cost.**, then choose **Start**.

### Generate the pages

When the outline is ready, review how many pages exist and how many are in the next batch. Choose **Generate pages**, approve that job, and choose **Start**. **Open Atlas** becomes available after the first pages are published. Choose **Generate more pages** for later batches.

**Note:**
The credit ceiling applies to output for one job. Input cost is not capped. The confirmation shows whether the job uses Estelle Credits or your own provider key.

## Read and ask questions

Open a page in the tree to read it. Use **On this page** to move between sections, and open a cited file when you want to check the source yourself.

Ask a question from any page. The answer opens as an **Ask** page inside the reader:

- **Atlas pages** lists pages related to your question.
- **Answer** contains Estelle's response and the sources it used.
- **Pages that cite the same files** helps you continue into related parts of the repository.

Read citations as evidence to inspect, not as proof of every sentence. If Estelle cannot support an answer from the indexed repository, it shows **Estelle did not answer this.** and the reason. Any retrieved sources are offered for you to read directly; unchecked text is labelled as such.

For a longer conversation, choose **Continue this in Ask Estelle**.

## Regenerate after the code changes

An Atlas stays pinned to its source commit. When the repository moves on, the page rail shows **Repository is now at** the newer commit and offers **Regenerate**.

To rebuild the whole guide:

### Choose the refresh options

Choose **Regenerate Atlas** and select the repository. Leave **Refresh the index from GitHub first** selected when you want the new Atlas to include the latest pushed code. This preparation step spends no credits.

### Approve the rebuild

Review the pinned commit, funding, and limits. With Estelle Credits, the ceiling applies separately to the outline job and to each page batch; input cost is not capped. Tick **I approve regenerating every page on these terms.**, then choose **Regenerate Atlas**.

### Keep the tab open and read the result

Keep the regeneration tab open until it finishes. The result says how many pages were published. If a page was skipped because Estelle could not find enough evidence for it, expand the skipped-page list to see its slug and reason.

## Change depth, grouping, or storage

Open **Settings → Atlas**:

- **Depth** controls how much code each generated page covers and how long generation takes. The default is medium; low and high are also available.
- **Repository groups** lets you group related repositories, such as a web app, its API, and a shared library. Ask Estelle can then answer across that group.
- **Atlases and storage** lists each repository's Atlas and its storage. **Delete Atlas** removes its pages after confirmation; the repository index and memories remain.

## Limits

- Atlas does not update itself on a schedule. Regenerate it when you need a newer commit.
- Only indexed repositories can have an Atlas.
- Leaving a regeneration tab stops later batches from being started there; a job already submitted can still finish.
- A credit ceiling does not cap input cost.

## Related

- [Code graph](https://docs.fatelabs.ca/code-graph): Index and inspect the repository behind an Atlas.
- [Memory](https://docs.fatelabs.ca/memory): Find the decisions and sessions shown in Atlas.
- [GitHub](https://docs.fatelabs.ca/github): Connect and index a repository.
