Documentation for Suga, the platform for building and deploying cloud-native applications.
Visit docs.addsuga.com to view the live documentation.
To run the documentation locally:
# Clone the repository
git clone https://github.com/nitrictech/suga.git
cd suga/docs
# Run dev server
npx mint devView the documentation at http://localhost:3000
We welcome contributions to improve our documentation!
- Fork the repository
- Create a feature branch (
git checkout -b improve-docs) - Make your changes
- Test your changes locally
- Commit (
git commit -am 'Add documentation for feature X') - Push to the branch (
git push origin improve-docs) - Open a Pull Request
docs/
├── index.mdx # Homepage
├── quickstart.mdx # Getting started guide
├── cli-reference/ # CLI command documentation
│ └── introduction.mdx # CLI overview and commands
├── docs.json # Site configuration
└── logo/ # Logo assets
├── suga-light.svg
└── suga-dark.svg
- Use clear, concise language
- Include practical code examples
- Test all code snippets
- Follow the existing documentation style
- Keep content focused on user needs
- Issues: GitHub Issues
- Email: support@addsuga.com
- Dashboard: app.addsuga.com
Made with ❤️ by the Nitric team