This repository contains the official documentation for Swellchain, a restaking focused L2 built with the OP Stack. The repo provides comprehensive guides, API references, and technical specifications for developers integrating with Swellchain.
- Node.js 18.x or later
- pnpm (recommended), npm, or yarn
- Clone the repository:
git clone https://github.com/swellnetwork/swell-chain-docs.git
cd swell-chain-docs- Install dependencies:
pnpm install
# or
npm install
# or
yarn install- Start the development server:
pnpm dev
# or
npm run dev
# or
yarn dev- Open http://localhost:3000 in your browser to view the documentation.
/content- Main documentation content in MDX format/components- Reusable React components/lib- Utility functions and shared logic/public- Static assets and images
pnpm build- Build the production documentationpnpm start- Start the production serverpnpm lint- Run ESLintpnpm type-check- Run TypeScript type checking
We welcome contributions! Feel free to submit a PR or open an issue.
This project includes support for the /llms.txt specification, which helps language models better understand the documentation structure.
Two files are generated:
-
/llms.txt- A structured file that follows the llms.txt specification- Includes an overview of Swellchain
- Provides links to markdown versions of all documentation pages, organized by category
- Clean, machine-readable content optimized for LLM context
-
/llms-full.txt- A comprehensive file containing all documentation content- Contains the complete content of all documentation files in a single document
- Includes a table of contents organized by category
- Optimized for LLMs with larger context windows
- Allows LLMs to search through the entire documentation without following links
The markdown versions of all pages are also generated and served alongside the HTML versions with .md appended to the original URL.
To generate these files manually, run:
pnpm generate:llms-txtFor more information about the llms.txt specification, visit llmstxt.org.