Coolify Docs

Contribution Guide ​

Follow these steps to contribute to our documentation:

1. Fork and Clone the Repository ​

  • Fork the documentation repository on GitHub.
  • Clone your fork to your local system using:
    sh
    git clone https://github.com/your-username/your-repo-name.git
  • Navigate to the cloned directory:
    sh
    cd your-repo-name

2. Install Dependencies ​

Run one of the following commands to install dependencies:

sh
bun install
# or
npm install
# or
yarn install
# or
pnpm install

3. Start the Development Server ​

Run one of the following commands to start the development server:

sh
bun dev
# or
npm run dev
# or
yarn dev
# or
pnpm dev

This will start a local server and provide a URL to preview your changes.

4. Make Your Contribution ​

  • Edit an existing markdown file in the /docs directory.
  • Or create a new .md file inside /docs or its subdirectories.

5. Submit a Pull Request ​

  • Push your changes to your forked repository.
  • Create a pull request to merge your changes into the main documentation repository.

Thank you for contributing!