This repository contains the official documentation for Mach Protocol, a true cross-chain application infrastructure. The documentation is built using Mintlify and provides comprehensive guides, reference materials, and examples for developers integrating with Mach.
- Introduction - Overview of Mach Protocol and its capabilities
- Mach Protocol - Core concepts, architecture, and protocol details
- Mach SDK - Guides and references for the JavaScript/TypeScript SDK
- API Reference - Detailed API endpoint documentation
To preview the documentation locally:
- Install the Mintlify CLI:
npm i -g mintlify- Run the development server from the root of this repository:
mintlify dev- Visit
http://localhost:3000to see the documentation site.
To contribute to the Mach documentation:
- Fork this repository
- Create a new branch for your changes
- Make your updates
- Submit a pull request
Please ensure your updates match the existing style and tone of the documentation.
The site configuration is managed through docs.json in the root directory. This file controls:
- Navigation structure
- Theme and branding
- API settings
- External links
Changes to the main branch are automatically deployed to the live documentation site through the Mintlify GitHub integration.