This directory contains the complete documentation for the Paycrest Protocol, built with Mintlify.

"To accelerate the creation of democratized payment systems of the future"

Paycrest is building the infrastructure for a more inclusive, transparent, and efficient global payment ecosystem. Our documentation reflects this mission by providing comprehensive, accessible resources for developers, providers, and users of the protocol.

docs/ ├── mint.json # Mintlify configuration ├── openapi.yaml # OpenAPI specification ├── logo/ # Brand assets │ ├── dark.svg │ └── light.svg ├── introduction.mdx # Main introduction page ├── quickstart.mdx # Getting started guide ├── protocol-overview.mdx # Protocol architecture overview ├── concepts/ # Core concept pages │ └── participants.mdx # Protocol participants ├── api-reference/ # API documentation │ └── introduction.mdx # API reference introduction ├── implementation/ # Implementation guides ├── guides/ # How-to guides └── protocol/ # Protocol governance 

• Node.js 16+ installed
• Mintlify CLI installed

1. Install Mintlify CLI:

npm install -g mintlify

2. Install dependencies:

npm install

Start the development server:

mintlify dev

The documentation will be available at http://localhost:3000.

• Introduction: Overview of the Paycrest Protocol
• Quickstart: Step-by-step guide to create your first payment order
• Protocol Overview: Deep dive into architecture and components

• Participants: Understanding Senders, Recipients, Providers, and Aggregators
• Architecture: Technical architecture and component interactions
• Order Lifecycle: How payment orders flow through the system
• KYC/KYB: Identity verification and compliance requirements

• Introduction: API authentication, endpoints, and usage
• Sender Endpoints: Create and manage payment orders
• Provider Endpoints: Fulfill orders and manage liquidity
• General Endpoints: Protocol information and utilities

• Aggregator Setup: Deploy and configure aggregator nodes
• Provider Setup: Set up provider infrastructure and PSP integrations
• Sender Integration: Integrate the Paycrest API into your application
• Smart Contracts: Understanding the Gateway contract and interactions

• Creating Payment Orders: Best practices for order creation
• Fulfilling Orders: How providers fulfill payment orders
• Multi-Chain Support: Working with different blockchain networks
• Security Best Practices: Security considerations and recommendations

• PIP-0 Overview: Protocol Improvement Proposal overview
• Governance: Protocol governance and decision-making
• Security Considerations: Security model and considerations

The main configuration file that defines:

• Navigation structure: How pages are organized
• Branding: Logo, colors, and theme
• API integration: OpenAPI specification integration
• Social links: GitHub, Discord, etc.

The OpenAPI specification that defines:

• API endpoints: All available API endpoints
• Request/response schemas: Data structures
• Authentication: API key authentication
• Examples: Code examples for different languages

1. Create a new .mdx file in the appropriate directory
2. Add frontmatter with title and description
3. Update mint.json navigation to include the new page

The documentation uses Mintlify's built-in components:

• <Card>: For feature highlights
• <Steps>: For step-by-step guides
• <Note>: For important information
• <CodeGroup>: For multi-language code examples

The API documentation is automatically generated from the openapi.yaml file. To update:

1. Modify the OpenAPI specification
2. The changes will be reflected in the API reference section

1. Push changes to the repository
2. Mintlify will automatically build and deploy
3. The documentation will be available at your configured domain

1. Configure your domain in the Mintlify dashboard
2. Update DNS settings as instructed
3. The documentation will be available at your custom domain

1. Create a new .mdx file
2. Follow the existing structure and formatting
3. Include frontmatter with title and description
4. Update navigation in mint.json

1. Modify openapi.yaml with new endpoints or schemas
2. The API reference will automatically update
3. Test the changes locally with mintlify dev

When adding code examples:

• Use syntax highlighting for the appropriate language
• Include comments explaining the code
• Provide examples for multiple languages when possible
• Test the examples to ensure they work

For documentation issues or questions:

• GitHub: Create an issue in the repository
• Discord: Ask in the #documentation channel
• Email: Contact the documentation team

This documentation is licensed under the same license as the Paycrest Protocol.