Before you start ensure you have
- Created a GitHub account
- Understand the basics of collaborating on GitHub
For simple changes the GitHub web UI should suffice.
- Find the page you want to edit.
- Click the
Improve thisbutton, this will take you to the GitHub copy of the markdown for this page. - Make the changes you require. Ensure you verify your changes in the
Previewtab - Add a description of your changes
- Click
Propose File Changes
For more complex changes you should fork and then submit a pull request. This is useful if you are proposing multiple file changes
- Fork on GitHub
- Clone your fork locally
- Work on your changes
- Push the commits to GitHub
- Send a Pull Request on GitHub
For more information see Collaborating on GitHub especially using GitHub pull requests
The pages are currently rendered using MarkdownDeep with Markdown Extra Enhancements enabled.
As we apply a custom stylesheet in the documentation pages, there may be a significant difference between the GitHub flavoured Markdown and our visualisation. So when changes are accepted you should double check how the rendered version looks.
For editing markdown on your desktop using MarkdownDeep try the following
Ensure you enable MarkdownDeep Extras by going to
Tools > Options > Markdown > Markdown Processor > Markdown (Extra)
Ensure you enable MarkdownDeep Extras by going to
Settings > markdown extra > toggle the switch to red