Documentation
Introduction
Section titled “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
Section titled “Getting Started”Prerequisites
Section titled “Prerequisites”Local Setup
Section titled “Local Setup”Clone the repository
Open the project in your preferred code editor
Install dependencies:
Terminal window bun installStart the development server:
Terminal window bun devOpen your browser and navigate to
http://localhost:3000
Writing Documentation
Section titled “Writing Documentation”All documentation files are located in the /docs directory. We use MDX (Markdown + JSX) for our documentation.
Resources
Section titled “Resources”Here are useful resources that can help you write documentation:
Contributing
Section titled “Contributing”Creating Issues
Section titled “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
Section titled “Submitting Changes”Fork the repository
Create a new branch from
main:Terminal window git checkout -b docs/your-feature-nameMake your changes
Commit with a clear message:
Terminal window git commit -m "docs: add contributing workflow details"Push your changes and create a Pull Request
Review Process
Section titled “Review Process”Maintainers will review your PR ASAP
Address any requested changes
Once approved, your changes will be merged
The documentation site will automatically rebuild and deploy