Documentation

Introduction

This guide will help you get started with contributing to CanvasMC documentation. We aim to maintain clear, consistent, and helpful documentation for all our users.

Getting Started

Prerequisites

Local Setup

Clone the repository

Open the project in your preferred code editor

Install dependencies:

bun install

Start the development server:

bun dev

Open your browser and navigate to http://localhost:3000

Writing Documentation

All documentation files are located in the /docs directory. We use MDX (Markdown + JSX) for our documentation.

Resources

Here are useful resources that can help you write documentation:

Contributing

Creating Issues

Before making changes, create an issue to discuss your proposed documentation changes.

Check existing issues to avoid duplicates

Create a new issue

Clearly describe:

What needs to be changed/added
Why this change is needed
Which pages are affected

Submitting Changes

Fork the repository

Create a new branch from main:

git checkout -b docs/your-feature-name

Make your changes

Commit with a clear message:

git commit -m "docs: add contributing workflow details"

Push your changes and create a Pull Request

Review Process

Maintainers will review your PR within 2-3 business days

Address any requested changes

Once approved, your changes will be merged

The documentation site will automatically rebuild and deploy

Documentation

On this page