Coolify logoCoolify
Cloud

Coolify Docs Contribution Guide

Contribute updates and fixes to the Coolify documentation with the same workflow and review expectations as other Coolify contributions.

The short version

Fork coollabsio/coolify-docs, work from the next branch, run the docs locally with Bun, and open focused pull requests back to next.

Repository workflow

The docs follow the same branch model as Coolify: production lives on main, while new work lands in next first.

1

Fork the docs repository to your GitHub account

2

Clone your fork from the next branch

3

Create a small branch for your documentation change

4

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.
Local development

Install dependencies and start the documentation site from the repository root.

bun install
bun run dev

The development server starts at http://localhost:3000/docs/.

Package manager note

Bun is the expected package manager. If you use another tool locally, do not commit its lockfile or configuration files.

Writing and structure
  • 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.
Images and screenshots

Screenshots should make a step easier to follow, not decorate the page.

RuleExpectation
FormatUse .webp images for documentation screenshots and illustrations.
LocationPlace image files in public/images/..., then reference them from MDX as /images/....
ComponentUse 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" />
Submit your contribution

Make the review easy: show what changed, why it changed, and how you checked it.

1

Commit and push your changes to your fork

2

Open a pull request to coollabsio/coolify-docs

3

Set the base branch to next

4

Describe the update and add screenshots when useful

  • Open the pull request against the next branch.
  • 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.
Current docs note

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.

FAQ

Development guides

Coolify Core

Set up local development and prepare code contributions for the main Coolify repository.

  • Local stack setup
  • Development tools
  • Reset steps
View core guide

Service Templates

Add one-click service templates with the expected structure and verification.

  • Template structure
  • Metadata rules
  • Testing checklist
View service guide

API schema for unreleased docs

The API reference reads config/openapi.json. The fetch script defaults to upstream Coolify main; set COOLIFY_OPENAPI_URL to a raw schema URL for the intended release revision when documenting unreleased features. Check generated endpoint routes and redirects after refreshing the schema. Network failures preserve the local spec, so confirm that it contains the expected endpoints before committing API changes.

Coolify Core

Previous Page

Service Templates

Next Page

On this page

Coolify Docs Contribution Guide
API schema for unreleased docs