https://github.com/0xsequence/trails-docs
https://github.com/0xsequence/trails-docs
Last synced: 6 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/0xsequence/trails-docs
- Owner: 0xsequence
- Created: 2025-05-27T12:49:44.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-12-19T13:42:47.000Z (6 months ago)
- Last Synced: 2025-12-21T18:56:00.295Z (6 months ago)
- Language: MDX
- Homepage: https://docs.trails.build
- Size: 1.41 MB
- Stars: 2
- Watchers: 0
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Trails Documentation
Welcome to the Trails docs!
## What is Trails?
The onchain transaction rails for every token from every chain with every wallet with one, aggregated balance - powered by intents. Trails automatically detects and orchestrates the necessary steps in order to execute any cross-chain transaction with any token by swapping, bridging, and calling any arbitrary function. Integrate in seconds with only a few lines of code.
## Development
To install the repo, use the following command:
```bash
pnpm i
```
Run the following command at the root of your documentation (where docs.json is)
```bash
pnpm dev
```
We use Mintlify as the documentation framework. For more information on what components are available to structure your content, please refer to their [documentation](https://mintlify.com/docs/page).
## Contributing
We welcome contributions from the community to help improve our documentation! Here's how you can contribute:
1. **Fork the repository** and create your branch from `main`.
2. **Make your changes** to the documentation.
3. **Test your changes** locally using the Mintlify CLI. We also recommend running `pnpm test` after adding your changes and before creating a PR to validate any broken-links.
4. **Submit a pull request** with a clear description of your changes.
Our team reviews pull requests regularly and will provide feedback as needed. For substantial changes, please open an issue first to discuss what you'd like to change.
If you find any errors or have suggestions for improvements but don't want to contribute directly, please open an issue describing the problem or enhancement.
Thank you for helping make Trails better for everyone!
### Troubleshooting
Mintlify has a max capacity for large files such as high quality images or videos. If you deploy and your video or image is not showing on the preview link in your PR, we recommend deploying these first to a CDN in order to serve them.