Coolify Docs Contribution Guide
Contribute updates and fixes to the Coolify documentation with the same workflow and review expectations as other Coolify contributions.
Fork coollabsio/coolify-docs, work from the next branch, run the docs locally with Bun, and open focused pull requests back to next.
The docs follow the same branch model as Coolify: production lives on main, while new work lands in next first.
Fork the docs repository to your GitHub account
Clone your fork from the next branch
Create a small branch for your documentation change
Open the pull request back to next
- Do not open pull requests against
main. - Keep each branch focused on one docs fix, guide, or cleanup.
- Check nearby pages before changing structure or component patterns.
Install dependencies and start the documentation site from the repository root.
bun install
bun run devThe development server starts at http://localhost:5173/docs/.
Bun is the expected package manager. If you use another tool locally, do not commit its lockfile or configuration files.
- Use clear, simple English for readers who may not be native English speakers.
- Break guides into small steps that a new self-hoster can follow without guessing.
- Add screenshots when they help explain a screen, setting, or expected result.
- Use existing docs components and nearby pages as the pattern before creating anything new.
Screenshots should make a step easier to follow, not decorate the page.
| Rule | Expectation |
|---|---|
| Format | Use .webp images for documentation screenshots and illustrations. |
| Location | Place image files in public/images/..., then reference them from MDX as /images/.... |
| Component | Use the zoomable image component to add images to docs. |
Use this component for docs screenshots:
<ZoomableImage src="/images/path-to-the-image.webp" alt="Describe the image" />Example:
<ZoomableImage src="/images/applications/domain.webp" alt="Application domain settings" />Make the review easy: show what changed, why it changed, and how you checked it.
Commit and push your changes to your fork
Open a pull request to coollabsio/coolify-docs
Set the base branch to next
Describe the update and add screenshots when useful
- Open the pull request against the
nextbranch. - Explain what page or flow changed and why.
- Include screenshots when the change affects visible layout or user steps.
- Do not commit lockfiles or package-manager files from tools other than Bun.
- Keep one pull request focused on one documentation change.
The docs are actively being rewritten for better structure and clarity. Contributions that improve accuracy, reduce confusion, or follow the existing page patterns are especially helpful.
Coolify Core
Set up local development and prepare code contributions for the main Coolify repository.
- Local stack setup
- Development tools
- Reset steps
Service Templates
Add one-click service templates with the expected structure and verification.
- Template structure
- Metadata rules
- Testing checklist