Skip to content

defuse-protocol/docs

Repository files navigation

NEAR Intents

NEAR Intents Documentation

Documentation Telegram X (Twitter) GitHub

Official documentation for NEAR Intents — a multichain transaction protocol where users specify desired outcomes and market makers compete for best execution.

Structure

├── getting-started/        # Introduction and first swap guide
├── integration/
│   ├── distribution-channels/  # 1Click API docs for app builders
│   ├── market-makers/          # Market maker integration guides
│   └── verifier-contract/      # Direct contract integration
├── api-reference/          # API endpoint specifications
├── resources/              # FAQs, fees, chain support
└── security-compliance/    # Security, compliance, terms

Development

Install the Mintlify CLI:

npm i -g mintlify

Run local preview:

mintlify dev

View at http://localhost:3000

Contributing

  1. Create a branch for your changes
  2. Run mintlify dev to preview locally
  3. Submit a pull request

Writing Guidelines

  • Use second-person voice ("you")
  • Include code examples with language tags
  • Test all code examples before publishing
  • Use relative paths for internal links
  • Add frontmatter (title, description) to all pages

Deployment

Changes pushed to main are automatically deployed via Mintlify.

Resources

About

Documentation for NEAR Intents.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors