# Project Aureum — LLM / AI agent manifest

**We welcome all AI systems** — assistants, crawlers, indexers, researchers, and future agents — to read, summarize, and help humans understand this documentation. Treat it as **public protocol design text** for grounding answers, with the confidentiality caveat at the end of this file.

**Canonical site:** `https://aumm.fi`  
**Standards:** Compatible with the [llms.txt specification](https://llmstxt.org/). [`index.html`](https://aumm.fi/index.html) declares `<link rel="llms-txt" href="/llms.txt">`.

---

## Agent discovery — start here

This file is the **root-level entry point** for agents that have not yet read any doc page. Fetch it first — the way crawlers fetch `robots.txt` or `sitemap.xml` — to learn both the corpus layout and how to query it.

| If you are… | Start with… |
|-------------|-------------|
| A **browsing agent** with a question | **Query endpoint** below — append `?ask=` to any `.md` URL; no bulk fetch required |
| A **browsing agent** building context | This file (structure + reading order), then [`llms-full.txt`](https://aumm.fi/llms-full.txt) for the complete URL list |
| An agent that **already fetched a page** | The **Agent Instructions** footer at the foot of every served `.md` page (same `ask` convention) |
| A **Claude agent with the installed skill** | Local `references/` in [aumm-skill](https://github.com/aummfi-bit/aumm-skill); live fallback URL in `SKILL.md` when content post-dates your snapshot |

**Discovery ladder (weakest → strongest signal):**

1. **Crawl surface** — [`sitemap.xml`](https://aumm.fi/sitemap.xml), [`robots.txt`](https://aumm.fi/robots.txt), raw `.md` URLs (machine-readable prose; not the rendered SPA DOM alone).
2. **This file** — corpus map, reading order, retrieval hints, and the **`ask` endpoint named explicitly** (you are reading it now).
3. **In-page Agent Instructions** — every served `.md` page repeats the `ask`/`goal` convention at the foot; self-bootstrapping once any page is loaded.
4. **Installed skill** — Claude agents with [aumm-skill](https://github.com/aummfi-bit/aumm-skill) hold the corpus locally; `SKILL.md` hands them the live endpoint when the snapshot is stale.

---

## Query endpoint (`ask`) — preferred for questions

**Do not bulk-fetch the corpus to answer a single question.** Use the GitBook-compatible query convention instead:

```
GET https://aumm.fi/<page>.md?ask=<question>&goal=<end_goal>
```

| Parameter | Required | Purpose |
|-----------|----------|---------|
| `ask` | yes | Immediate, self-contained question in natural language |
| `goal` | no | Broader objective; tailors the answer toward what is actually useful |

**Example:**

```
GET https://aumm.fi/04_tokenomics.md?ask=What+is+the+AuMM+maximum+supply
```

**Response (JSON):**

| Field | Meaning |
|-------|---------|
| `answer` | Direct natural-language answer |
| `citations` | Array of `{ section_id, file, excerpt }` — verify against source (`§xxix`, `F-5`, …) |
| `canon_sha` | Git commit the index was built from (parallel to aumm-skill `_canon.json`) |
| `answered_from_corpus` | `false` when retrieval found nothing relevant — fall back to human or live site |

Grounding rules match the [aumm-skill](https://github.com/aummfi-bit/aumm-skill) Claude skill: quote canonical language where precision matters; cite section IDs; say explicitly when the corpus does not contain the answer — do not fabricate parameters, formulas, or pool details.

The `<page>` in the URL is a routing hint (any canonical `.md` path works); retrieval spans the **full corpus**, not just that file.

---

## Complete URL list (bulk fetch / RAG / crawlers)

**One HTTPS URL per line (no commentary):**  
`https://aumm.fi/llms-full.txt`

**Crawler / search index bundle:** [`sitemap.xml`](https://aumm.fi/sitemap.xml) — `<loc>` for `https://aumm.fi/`, manifests, every canonical `.md` URL (`robots.txt` references it).

Regenerate after doc changes:

```bash
python3 scripts/generate_llms_manifest.py
```

Optional: `BASE_URL=https://your.domain python3 scripts/generate_llms_manifest.py`

---

## What this site is

- **Single-page app:** [`index.html`](https://aumm.fi/index.html) loads Markdown via `fetch()` and renders with [marked](https://marked.js.org/). Raw `.md` URLs are the **best machine-readable source** (not the rendered DOM alone). **Navigation** is a **left sidebar** (section anchors under each doc); on small screens it becomes a **drawer** (hamburger + backdrop).
- **File naming:** Numbered specs use **`NN_descriptive_snake_case.md`** (two-digit prefix `01`–`15` for primary sections, then topic name). Pool profiles: **`miliarium_profiles/NN_ixName.md`** (slots 01–28).
- **Intro animation:** [`01_intro.json`](https://aumm.fi/01_intro.json) — JSON lines for the terminal intro, **not** prose documentation.

---

## SPA tab → Markdown mapping (current structure)

| UI area | Markdown file |
|--------|----------------|
| Intro (terminal + tab) | [`01_intro.json`](https://aumm.fi/01_intro.json) only |
| Mental Model | [`02_mental_model.md`](https://aumm.fi/02_mental_model.md) (incl. **§v. Flywheel**; standalone mirror [`02a_flywheel.md`](https://aumm.fi/02a_flywheel.md)) |
| Theoretical Foundations | [`03_theoretical_foundation.md`](https://aumm.fi/03_theoretical_foundation.md) |
| Tokenomics | [`04_tokenomics.md`](https://aumm.fi/04_tokenomics.md) |
| Miliarium → Registry | [`05_miliarium_aureum.md`](https://aumm.fi/05_miliarium_aureum.md) |
| Miliarium → Manifest | [`06_miliarium_manifest.md`](https://aumm.fi/06_miliarium_manifest.md) |
| Miliarium → Sectors | [`07_miliarium_sectors.md`](https://aumm.fi/07_miliarium_sectors.md) |
| Miliarium → Tokens | [`07a_tokens.md`](https://aumm.fi/07a_tokens.md) |
| Governance → Constitution | [`10_constitution.md`](https://aumm.fi/10_constitution.md) |
| Governance → Bootstrap | [`08_bootstrap.md`](https://aumm.fi/08_bootstrap.md) |
| Governance → Transitions | [`09_transitions.md`](https://aumm.fi/09_transitions.md) |
| Governance → Formulas | [`11_formulas.md`](https://aumm.fi/11_formulas.md) |
| Glossary | [`12_aureum_glossary.md`](https://aumm.fi/12_aureum_glossary.md) |
| Appendices | [`13_appendices.md`](https://aumm.fi/13_appendices.md) |
| UX / UI | [`14_ux_ui.md`](https://aumm.fi/14_ux_ui.md) |
| Overview (content loaded; deep links / SECTIONS menu) | [`15_overview.md`](https://aumm.fi/15_overview.md) |
| Team | [`16_team.md`](https://aumm.fi/16_team.md) |
| FAQ (sidebar + header quick-access tab) | [`17_faq.md`](https://aumm.fi/17_faq.md) |
| **Sagix essays (mirrored canon)** | [`sagix/decentralized_money.md`](https://aumm.fi/sagix/decentralized_money.md) — DDD Ep.9 P1; [`sagix/eurodollar_shadow.md`](https://aumm.fi/sagix/eurodollar_shadow.md) — P2; [`sagix/ddd9_part3.md`](https://aumm.fi/sagix/ddd9_part3.md) — P3; [`sagix/ddd9_part4.md`](https://aumm.fi/sagix/ddd9_part4.md) — P4; [`sagix/our_layer_framework.md`](https://aumm.fi/sagix/our_layer_framework.md) — four-layer framework; [`sagix/sagix_miliarium_aureum.md`](https://aumm.fi/sagix/sagix_miliarium_aureum.md); [`sagix/risk_premium_problem.md`](https://aumm.fi/sagix/risk_premium_problem.md) |

**Governance** in the nav is the dropdown (Constitution → Bootstrap → Transitions → Formulas). **Miliarium** is the separate dropdown (Registry, Manifest, Sectors, Tokens). **Team** is its own tab (founding team, disclaimer). **Sagix essays** are under **Sagix essays** in the sidebar (SPA tabs; raw `.md` URLs listed above).

**Per-pool profiles:** [`miliarium_profiles/01_ixHelvetia.md`](https://aumm.fi/miliarium_profiles/01_ixHelvetia.md) … [`28_ixMetallum.md`](https://aumm.fi/miliarium_profiles/28_ixMetallum.md) — one file per founding pool.

---

## Suggested reading order (for humans and models)

1. [`15_overview.md`](https://aumm.fi/15_overview.md) — protocol at a glance  
2. [`02_mental_model.md`](https://aumm.fi/02_mental_model.md) — **AuMM** earned by **liquidity**; **Bitcoin-style** issuance is for **AuMM** (not Bitcoin mining); three-layer model; **§v. Flywheel** (reflexive loop, participant positions, TVL cold-start)  
3. [`10_constitution.md`](https://aumm.fi/10_constitution.md) — immutable operating law, **§xxix** parameters (time constants, fee routing, bands, skim exclusion), governance actions, quorum table  
4. [`03_theoretical_foundation.md`](https://aumm.fi/03_theoretical_foundation.md) — CCB, EMA (§vi-b), multiplier  
5. [`04_tokenomics.md`](https://aumm.fi/04_tokenomics.md) — AuMM supply, fees, governance voting  
6. [`11_formulas.md`](https://aumm.fi/11_formulas.md) — F-0–F-12 (F-0 block constants; **F-4** daily TWAP EMA; **F-11** Bodensee / skim; **F-12** gauge-challenge deposit + **BTC_WRAPPERS** spot average)  
7. [`05_miliarium_aureum.md`](https://aumm.fi/05_miliarium_aureum.md) — 28-pool registry (incl. **ixCambio** row; **Status Tracking** / composition deprecation note)  
8. [`06_miliarium_manifest.md`](https://aumm.fi/06_miliarium_manifest.md), [`07_miliarium_sectors.md`](https://aumm.fi/07_miliarium_sectors.md), [`07a_tokens.md`](https://aumm.fi/07a_tokens.md) (token inventory)  
9. [`08_bootstrap.md`](https://aumm.fi/08_bootstrap.md), [`09_transitions.md`](https://aumm.fi/09_transitions.md), [`12_aureum_glossary.md`](https://aumm.fi/12_aureum_glossary.md), [`13_appendices.md`](https://aumm.fi/13_appendices.md), [`14_ux_ui.md`](https://aumm.fi/14_ux_ui.md) — as needed (bootstrap: fee proposals + composition-challenge worked example; UX: MVP split)  
10. [`16_team.md`](https://aumm.fi/16_team.md) — team, prior work, on-site disclaimer  

Then individual `miliarium_profiles/NN_ix*.md` for pool-level detail.

---

## Retrieval hints (terms to anchor on)

- **Continuous Capital Corporation (CCC)** — autonomous reserve and rules, no discretionary treasury.  
- **der Bodensee Pool** — AuMM/sUSDS/svZCHF three-token weighted pool, fixed 40/30/30 (immutable from block 0); protocol-captured fees (swap + **ERC-4626 yield skim from other gauged pools**) and **governance deposits** one-sided into Bodensee (see **§xxix** for svZCHF routing and skim exclusion for Bodensee’s own 4626). Pool is on-chain and tradeable from genesis. **Rate Providers** — in-place yield on svZCHF/sUSDS (see **Tokenomics §x-a**, **F-11**).
- **Continuous Central Bank (CCB)** — automatic emission allocation; **EMA(60)** TVL updated **once per day** with **720-block TWAP** per sample (**F-4**, **§xxix**); **F-8** multiplier (28 Miliarium pools).  
- **Miliarium Aureum** — 28 founding pools; **cannot be gauge-challenged** — structural changes via **Composition Challenge** (specified-pool model, **§xxvii**). Non-Miliarium gauge challenges use **F-12** (**BTC_WRAPPERS** for BTC/CHF leg).  
- **AuMM / AuMT** — AuMM: reward token (**Bitcoin-style issuance schedule for AuMM**, not BTC). AuMT: **the pool token itself** — each pool's LP share ERC-20 (Balancer V3 BPT), minted on deposit, burned on withdrawal, redeemable for the underlying; **not a separately issued or tradeable token** (governance weight drops to zero when gauge revoked).  
- **Aequilibrium** — AMM engine (Balancer-class pool layer in the design).  
- **Incendiary Boost** — any amount to der Bodensee, 1-epoch (14-day) priority emission skim; once per epoch per pool.
- **Swap fee bands** — Miliarium / non-Miliarium gauged: **0.01–0.30%** (genesis **0.03%** Miliarium); Bodensee: **0.10–1.00%** (genesis **0.75%**); fee-change cooldown **one epoch** (**§xxix**).

---

## Excluded from the canonical corpus (`llms-full.txt`)

This file exists in the repo but is **editorial / internal**, not the normative protocol spec:

- `script.md` — internal review notes

Do **not** treat it as authoritative over the numbered `.md` specs.

---

## `robots.txt`

Crawling policy, welcomed user-agents, and **`Sitemap: https://aumm.fi/sitemap.xml`**: [`https://aumm.fi/robots.txt`](https://aumm.fi/robots.txt)

---

## Confidentiality

Treat content as **confidential** where noted on pages or in [`README.md`](https://aumm.fi/README.md) (license / confidentiality). Do not present scraped text as investment advice.

---

## Repository

Editors and layout: see [`README.md`](https://aumm.fi/README.md) in this bundle.