If you want to update or add documentation to Submitty.org here’s what you do:
-
If you haven’t already, you’ll need to clone the git repo of Submitty.org:
git clone https://github.com/Submitty/submitty.github.io.git
-
After cloning the repo, go into the
_docs
folder. You will see a folder representing each major category on Submitty.org -
Navigate to whichever page you want to edit and open it in your text editor of choice. The files are written in Markdown.
-
Run Jekyll locally to generate and view the webpages and proofread your edits: README.md
-
After you are done editing, you can submit a pull request for review.