Trunk.io documentation (docs.trunk.io)

This repository is the official repo for docs.trunk.io. If you see any mistakes or any improvements that can be made, we'd love your contributions!

Local Development

This repo is synced with GitBook via Git Sync. Content pushed to main is automatically published to docs.trunk.io. To preview changes before publishing:

Setup

1. Push your feature branch to GitHub:

   git push -u origin your-branch-name

2. In the GitBook editor, create a Change Request linked to your branch.
3. GitBook will render your branch content in a preview, separate from the published docs.

Workflow

Edit locally → git push → GitBook auto-syncs branch → Preview in GitBook editor
                                                        ↓
                                              Review & iterate
                                                        ↓
                                              Merge PR on GitHub → publishes to docs.trunk.io

• Every push to your branch updates the GitBook preview automatically
• Edits made in the GitBook web editor push commits back to your branch
• Nothing goes live on docs.trunk.io until the branch merges to main

Contributing

If you see any mistakes or any improvements that can be made, we'd love your contributions! Just fork the repo and open a PR with your changes. While you're browsing docs.trunk.io, you can get to the GitHub source for that page via the ... menu → Edit on GitHub:

Feedback, Advice, and Help

Come chat with us in our Slack Community ❤️