> For the complete documentation index, see [llms.txt](https://docs.takeover.fun/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.takeover.fun/readme.md).

# Takeover Developer Docs

Source for [docs.takeover.fun](https://docs.takeover.fun) — the developer-facing documentation for [Takeover](https://takeover.fun).

These docs target **UGM v2.3**, the contract that hosts every Takeover board on Base mainnet and Base Sepolia today.

## Building with an AI agent? Start here

The fastest way to ship something on Takeover is to point an agent at the [Agent skills](/agent-skills/skills.md) section and pick the task that matches your goal:

1. [Skill: launch a grid](/agent-skills/launch-grid.md) — atomic, chunked, or sharded grid creation.
2. [Skill: build a yield adapter](/agent-skills/build-yield-adapter.md) — bridge your protocol's yield into UGM v2.3.
3. [Skill: build a hook module](/agent-skills/build-hook-module.md) — gate seat economics and drive forced transfers via `IGridHooksV23`.

Each skill page is structured for an agent to follow end-to-end: read-order links, code patterns, validation tables, gas budgets, and the [machine-readable checklist](https://github.com/takeoverapp/takeover-docs/blob/main/submit/checklist.yml).

## Cold start (humans)

If you are a protocol engineer and want your protocol's yield to flow into a Takeover board (a UGM v2.3 grid), the canonical reading order is:

1. [Whitepaper](/whitepaper/whitepaper.md) — protocol design and Harberger mechanics.
2. [What is Takeover](/concepts/what-is-takeover.md) — conceptual model.
3. [UGM v2.3](/concepts/ugm-v2.3.md) — what the live contract does.
4. [The yield adapter model](/concepts/yield-adapter-model.md) — how external yield sources connect.
5. [The hook model](/concepts/hook-model.md) — how policy modules layer on top.
6. [Building a yield adapter](/yield-adapters/building-an-adapter.md) — full walkthrough.
7. [Submission checklist](/submit/checklist.md) — pre-flight before guardian approval.

## Repository

This repo is the source of truth for the docs. Markdown lands here; GitBook syncs from `main` and renders the public site.

```
skills/     # Agent-facing skills (lead the navigation)
overview/   # Concepts and mental model
boards/     # Things grid creators do (atomic, chunked, sharded creation)
adapters/   # IYieldAdapter, lifecycle, how to build one, examples
hooks/      # IGridHooksV23, lifecycle, registration, examples
reference/  # API reference, events, deployments, glossary
submit/     # Checklist + adapter approval process
```

See [`SUMMARY.md`](https://github.com/takeoverapp/takeover-docs/blob/main/SUMMARY.md) for the full table of contents.

## Contributing

See [`CONTRIBUTING.md`](https://github.com/takeoverapp/takeover-docs/blob/main/CONTRIBUTING.md). Short version: branch from `main`, one topic per PR, run `npx markdownlint-cli2 "**/*.md"` locally before pushing, link to a reference adapter or hook module in [`takeoverapp/takeover-contracts`](https://github.com/takeoverapp/takeover-contracts) whenever you can.

## License

MIT — see [`LICENSE`](https://github.com/takeoverapp/takeover-docs/blob/main/LICENSE/README.md).


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.takeover.fun/readme.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.