Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
GarboMuffin committed Nov 29, 2021
1 parent a9e3163 commit 01801fd
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 2 deletions.
1 change: 1 addition & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
See https://github.com/TurboWarp/docs#writing-content
20 changes: 18 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 01801fd

Please sign in to comment.