Skip to content

Commit d09bd8f

Browse files
authored
Add CONTRIBUTING.md and improve guidance (plus other changes) (#47)
* Update README.md * feat: Add CONTRIBUTING.md and improve the guidance * chore: remove dead link to v3 docs
1 parent b88c881 commit d09bd8f

File tree

2 files changed

+18
-14
lines changed

2 files changed

+18
-14
lines changed

CONTRIBUTING.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
## Contributing Guide
2+
3+
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.
4+
5+
> [!CAUTION]
6+
> 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.
7+
8+
> [!TIP]
9+
> 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.
10+
11+
### Local preview
12+
13+
If you want to preview locally, clone the repo and then run `pip install -r requirements.txt` and `mkdocs serve`.
14+
15+
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.
16+
17+
This is normal as the v4 documentation uses a newer version of MkDocs that is configured differently.

README.md

Lines changed: 1 addition & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -5,22 +5,9 @@
55
This is the source for the Discord Tickets v4 documentation (and marketing) website.
66
You can view the latest build of the site [here](https://discordtickets.app/).
77

8-
> **Note**
9-
> For the v3 documentation, visit [v3.discordtickets.app](https://v3.discordtickets.app) or look at the `v3.1` branch.
10-
118
## Contributing
129

13-
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.
14-
15-
**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.
16-
17-
### Local preview
18-
19-
If you want to preview locally, clone the repo and then run `pip install -r requirements.txt` and `mkdocs serve`.
20-
21-
If you choose to run a local preview, the site will not look the same as the production version,
22-
because it is built with a specific version of the Insiders edition of the theme, which has additional features and a different config.
23-
This is normal as the v4 documentation uses a newer version of MkDocs that is configured differently.
10+
See [CONTRIBUTING.md](./CONTRIBUTING.md)
2411

2512
## Spontaneous Puffin Image
2613

0 commit comments

Comments
 (0)