Splits Protocol Docs

Documentation for the Splits protocol, SDKs, and developer tools.

The published site lives at splits.org/protocol/docs. It explains how to use Splits' onchain revenue infrastructure, including payment splits, waterfalls, vesting, swappers, liquid splits, and the TypeScript SDK.

Contents

• Protocol introduction and flow of funds
• SDK guides for @0xsplits/splits-sdk
• React SDK and SplitsKit docs
• Core contract docs
• Template contract docs
• llms.txt and generated llms-full.txt for AI agents and search tools

Development

Install dependencies:

pnpm install

Start the local docs server:

pnpm dev

Open http://localhost:3002.

Build the production site:

pnpm build

The build generates public/llms-full.txt, builds the Nextra site, and generates the sitemap.

Editing Docs

Most pages are MDX files under pages/. Navigation labels and ordering are controlled by _meta.json files in each section.

When adding or moving content:

• Add the page under the relevant pages/ section.
• Update the nearest _meta.json so the page appears in the sidebar.
• Update public/llms.txt when the new content should be discoverable by AI agents.
• Keep user-facing product support content in the Help Center unless it belongs in technical protocol or SDK docs.

Related Repositories

• splits-contracts-monorepo for current Splits contracts
• splits-contracts for legacy protocol contracts
• splits-sdk for TypeScript SDK packages