GitHub - veyatziv/docs: Jupiter Developer Docs

Jupiter Developers Documentation

Welcome to Jupiter! You'll find detailed API, powerful tool kits and technical deep dives built/written by the team to help you build with Jupiter.

Contributing

To contribute to our documentation, please follow the steps below.

  1. Fork the repository
  2. Create a new branch
  3. Make your changes
  4. Submit a pull request
  5. Wait for review
  6. Merge your changes
  7. Celebrate!

Support

If you need help, reach out to our developer community in Discord.

Development

Install the Mintlify CLI to preview your documentation changes locally. To install, use the following command:

Run the following command at the root of your documentation, where your docs.json is located:

View your local preview at http://localhost:3000.

Use the following command to check for broken links in pages:

Troubleshooting

  • If your dev environment isn't running: Run mint update to ensure you have the most recent version of the CLI.
  • If a page loads as a 404: Make sure you are running in a folder with a valid docs.json.

Resources