> For the complete documentation index, see [llms.txt](https://docs.soroswap.finance/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.soroswap.finance/claude.md).
# CLAUDE.md
Public product documentation for Soroswap Finance: the AMM, the Aggregator and the swap API.
The site is built by **Mintlify**. Pages are MDX, navigation lives in `docs.json`, and `CLAUDE.md` is excluded from the build via `.mintignore`.
## Serving locally to see a change
```bash
npx mint@latest dev --port 3333
```
Hot reload picks up edits. One check before committing:
```bash
npx mint@latest broken-links
```
That command also parses every page, so an MDX syntax error surfaces there even if the link check itself passes. A page that fails to parse is reported by file and position.
## MDX rules that differ from plain Markdown
Every page is parsed as MDX. Things that silently worked in GitBook break the build here:
* HTML comments are `{/* ... */}`, never ``.
* Void tags self-close: ` `, ``, ``.
* A literal `<` or `{` in prose starts JSX. Keep placeholders like `` and expressions like `a <-> b` inside backticks or code fences.
* Image paths are root-relative (`/images/foo.png`). Relative paths do not resolve.
* Callouts are components: ``, ``, ``, ``, ``, ``.
* Cards are `` inside ``.
* LaTeX works natively: `$...$` inline, `$$...$$` blocks.
* No GitBook syntax survives: no `{% hint %}`, no `{% embed %}`, no ``. Use ``, a raw `