diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..01aa01c --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,17 @@ +## Contributing Guide + +For simple changes, you can easily create a fork, edit the files you want to change, open a PR, and see the result with the PR deploy preview from the Netlify bot. + +> [!CAUTION] +> The documentation only supports *British* English for written language. [Spell checks](https://github.com/discord-tickets/docs/actions/workflows/spelling-check.yml) will fail if you use other languages or other forms of English. Code, code snippets, config files, etc can be in American English. + +> [!TIP] +> If you are editing tables, please clone the repository locally and edit it with an appropriate IDE (like VS Code) using a markdown formatting extension. + +### Local preview + +If you want to preview locally, clone the repo and then run `pip install -r requirements.txt` and `mkdocs serve`. + +If you choose to run a local preview, the site will not look the same as the production version, this is because it is built with a specific version of the Insiders edition of the theme, which has additional features and a different config. + +This is normal as the v4 documentation uses a newer version of MkDocs that is configured differently. diff --git a/README.md b/README.md index b4d131f..061590c 100644 --- a/README.md +++ b/README.md @@ -5,22 +5,9 @@ This is the source for the Discord Tickets v4 documentation (and marketing) website. You can view the latest build of the site [here](https://discordtickets.app/). -> **Note** -> For the v3 documentation, visit [v3.discordtickets.app](https://v3.discordtickets.app) or look at the `v3.1` branch. - ## Contributing -For simple changes, you can easily create a fork, edit the files you want to change, open a PR, and see the result with the PR deploy preview from the Netlify bot. - -**If you are editing tables**, please clone the repository locally, edit with an appropriate IDE (such as VS Code) and use a markdown formatting extension. - -### Local preview - -If you want to preview locally, clone the repo and then run `pip install -r requirements.txt` and `mkdocs serve`. - -If you choose to run a local preview, the site will not look the same as the production version, -because it is built with a specific version of the Insiders edition of the theme, which has additional features and a different config. -This is normal as the v4 documentation uses a newer version of MkDocs that is configured differently. +See [CONTRIBUTING.md](./CONTRIBUTING.md) ## Spontaneous Puffin Image