Skip to content

hyperlane-xyz/v4-docs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

41 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Hyperlane Documentation

Developer documentation for the Hyperlane Protocol.

This documentation provides comprehensive guides, API references, and examples for building cross-chain applications with Hyperlane.

What You'll Find Here

  • Protocol Overview - Understanding Hyperlane's architecture and core concepts
  • Developer Guides - Step-by-step tutorials for building interchain applications
  • Smart Contract References - Complete API documentation for Hyperlane contracts
  • SDK Documentation - TypeScript/JavaScript library references
  • Security Modules - Configuring and deploying custom security models
  • Deployment Guides - Production deployment best practices

Local Development

Install the Mintlify CLI to preview documentation changes locally:

npm i -g mintlify

Run the development server at the root of the documentation directory:

mintlify dev

Contributing

This documentation is open source and contributions are welcome. To contribute:

  1. Fork this repository
  2. Make your changes locally using mintlify dev
  3. Submit a pull request

Support

For questions about Hyperlane:

Troubleshooting

  • Mintlify dev isn't running: Run mintlify install to re-install dependencies
  • Build errors: Check that all referenced files exist and paths are correct

About

Developer documentation for the Hyperlane Protocol

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published