Welcome to the quayside Wiki!

This is where we outline the decisions and discoveries we made along the way!

Contributing to the Wiki

All the files for this website our stored a md files in our github repository. You can edit and add to the md files by cloning the repository locally.

Setup. First, install docsify-cli to preview the website pages locally using npm i docsify-cli -g (if you don't have npm, you can download it through node.js). Once installed, clone our github repository.

Running

Then in that directory run docsify serve to preview the site locally in your browser.

Editing. Make a md file for each page in the wiki, under the proper folder. Look at other md files for formatting guidelines; each wiki page should have a title, name of the editor(s), and date it was created. The wiki link should then be added to _sidebar.md so it shows up in the sidebar- in the future we should have a script do this for us ;).

Once you are finished editing, push your files to the main branch and the github pages wiki website will update.

Documentation for the Documentation

Here is a markdown cheat sheet.
Here is the docsify docs.