# HypurrFi Documentation Project

## About

This is the documentation site for [HypurrFi](https://hypurrfi.com), built on [Tome](https://github.com/tomehq/tome). HypurrFi builds lending, credit, and infrastructure products on Hyperliquid EVM (HyperEVM).

For full protocol context, integration patterns, and help bot instructions, see **`SKILL.md`** in this repo root.

## Content Structure

The docs are organized into sidebar groups in `tome.config.js`:

- **About / Products / Risk & Security / Education / Brand** — user-facing tutorials, product explainers, how-to guides. Written in second person with Tome components (Steps, Callouts, Accordions).
- **Agent Overview / Protocol References** — agent-readable protocol references. Dense, code-first, self-contained. No UI components.
- **AI Tools** — setup instructions for AI coding agents (Cursor, Claude Code, Windsurf).
- **Developer Overview / Guides / Smart Contracts** — technical references: smart contract APIs, integration guides, contract addresses.

All documentation pages live in the `pages/` directory.

## Terminology (Critical)

- **HypurrFi Prime** — isolated lending markets (Euler V2), fully cross-collateralized cluster for highly liquid assets
- **HypurrFi Yield** — isolated lending markets (Euler V2), yield-bearing HYPE leverage strategies. NOT earn vaults.
- **HypurrFi Scale** — isolated lending markets (Euler V2), USDXL-centric cluster for long-tail collaterals (PURR, UFART, UPUMP, bbHLP, haHYPE)
- **HypurrFi Markets** — umbrella name for Prime + Yield + Scale (the Euler V2 stack)
- **Earn Vaults** — curated managed strategies routing deposits to Prime/Yield/Scale markets. Separate product from Prime/Yield/Scale.
- **Pooled Markets** — shared-pool lending (Aave V3.0.2). Do not call it "Aave."
- **Legacy Markets** — deprecated Fraxlend-based isolated markets. Repay and withdraw only.
- **Mewler** — community name for HypurrFi Markets. Acceptable in casual references.
- **USDXL** — CDP-hybrid synthetic dollar. **NEVER call it a "stablecoin."** This is a compliance requirement.
- **"Vault"** — In Euler terminology, every lending market is a "vault." Do not confuse with HypurrFi's "Earn Vaults" product.

## Style

- **User-facing pages**: active voice, second person ("you"), Tome components (Callout, Steps, Accordion), step-by-step tutorials
- **Agent pages**: code-first, flat structure, all addresses inline, self-contained, no UI components
- **Developer pages**: technical accuracy, Solidity/TypeScript examples, API signatures
- Use sentence case for headings
- Bold for UI elements: Click **Settings**
- Code formatting for file names, commands, paths, and code references

## Component Reference

Tome components are available in `.mdx` files without imports:

- `<Callout type="info|warning|tip|danger">` — replaces Mintlify's `<Note>` and `<Warning>`
- `<Card title="..." href="...">` — link cards
- `<CardGroup cols={2}>` — card grid layout
- `<Steps>` with `<div>` children — numbered step sequences
- `<Accordion title="...">` — collapsible content
- `<Tabs items={["a","b"]}>` — tabbed content

## Local Development

```bash
npm install
npm run dev    # starts at localhost:3000
```

Node 18+ required.