Contributing to the Wiki
This wiki is built with Markdown and hosted on GitHub. Contributions of all kinds are welcome: fixing typos, improving guides, or adding new content.
Don't let worry about format or correctness stop you. There's a review process and everything can be undone. If you've never used GitHub before, this is a great chance to get started.
Editing an existing page
Every page has an Edit this page on GitHub link at the bottom. Click it to open the file directly in GitHub's editor.
- Make your changes in Markdown
- Scroll down and choose Create a new branch and start a pull request
- Submit the pull request; a maintainer will review and merge it
Adding a new page
- Navigate to the correct folder in the GitHub repository (e.g.
user/for user guides,dev/for developer docs) - Click Add file > Create new file
- Name your file (e.g.
my-guide.md) - Add frontmatter at the top:
yaml
---
title: My Guide Title
---- Write your content in Markdown below the frontmatter
- Scroll down and open a pull request
To have the page appear in the sidebar, let a maintainer know in your PR or on Discord. Sidebar entries are managed in .vitepress/config.mjs.
Including screenshots
You can paste images directly into the GitHub Markdown editor and it will upload them automatically. Please crop images to the relevant area before pasting:
- Windows:
Win+Shift+S(Snipping Tool) orAlt+Print Screen(active window) - Mac:
Cmd+Shift+4(selection) orCmd+Shift+4thenSpace(window)
