diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..7308c282 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1 @@ +See https://github.com/TurboWarp/docs#writing-content diff --git a/README.md b/README.md index a34874b5..1cf08c6e 100644 --- a/README.md +++ b/README.md @@ -4,9 +4,25 @@ https://docs.turbowarp.org/ This repository contains documentation for TurboWarp. -Built with [Docusaurus](https://docusaurus.io/). Documentation is inside the `docs` folder, generally that is all you will have to touch. We accept pull requests. +## Writing content -To build locally locally: +If you found a typo, have a suggestion, the easiest way to get it fixed is to post about it on this Scratch profile and it will get fixed quickly: https://scratch.mit.edu/users/GarboMuffin/#comments + +Alternatively, you can submit a pull request containing a fix. The easiest way to edit a page is: + +1. Open the website, https://docs.turbowarp.org/ +2. Find the page you want to edit +3. Click "Edit this page" at the bottom +4. Sign in with a GitHub account +5. Fork the repository +6. Use the GitHub editor to modify the file. It uses [Markdown syntax](https://www.markdownguide.org/basic-syntax/). +7. Click "Propose Changes" + +If you'd like to write a new page, we'd prefer that you ask us first before you spend much time writing. + +## Local Development + +This website is built with [Docusaurus](https://docusaurus.io/). Documentation is inside the `docs` folder, generally that is all you will have to touch. We accept pull requests. ```bash npm install