Tulip documentation instructions
About this project
- This is a documentation site built on Mintlify
- Pages are MDX files with YAML frontmatter
- Configuration lives in
docs.json - Use the Mintlify MCP server,
https://mcp.mintlify.com, to edit content and settings via MCP - Use the Mintlify docs MCP server,
https://www.mintlify.com/docs/mcp, to query information about using Mintlify via MCP
Terminology
- Use model credit for the canonical ERC-20 associated with a pinned model revision.
- Use model market for one ModelID, one credit, one credit/USDG pool, and its provider offers.
- Use provider offer for an operator’s endpoint, payout address, and tariff.
- Use market creator for the address that launches a canonical model market.
- Use provider for the independent operator serving inference. Do not imply that the creator is the provider.
- Use inference permit for a user’s bounded on-chain credit deposit.
- Use USDG, not dollars, when describing the quote asset.
- Say Robinhood Chain, not Robinhood L2.
- Do not describe one-sided launch liquidity as synthetic USDG. The pool starts with model credits only and accumulates real USDG from buyers.
Style preferences
- Use active voice and second person (“you”)
- Keep sentences concise — one idea per sentence
- Use sentence case for headings
- Bold for UI elements: Click Settings
- Code formatting for file names, commands, paths, and code references
Content boundaries
- Document behavior implemented in the current contracts, gateway, indexer, and frontend.
- Do not publish local fork addresses, private endpoint URLs, credentials, or test keys.
- Do not present unaudited contracts as production-ready.
- Do not describe Mako as a Tulip model or Tulip-owned project.
- Mark functionality that requires a public Tulip deployment as unavailable until addresses are published.
Source of truth
- Contract mechanics:
../../contracts/src - Deployment defaults:
../../contracts/script/DeployRobinhood.s.sol - Gateway behavior:
../../gateway/src - Indexer behavior:
../../indexer/src - Product workflows:
../../frontend/app