FunkyApple Docs

These are a collection of documents intended for education purposes. If you are interested in contributing, feel free to make a PR.

Contributing

How to actual run and test the documents. The easiest way is to use poetry but honestly you can also use pip.

1. Install poetry and pyenv (recommended).
2. Fork and clone the repo to your device.
3. In the repo folder type:

poetry install

4. This will install all the required dependancies. Make sure poetry shell is activated by typing poetry shell and then run:

mkdocs serve

Make the intended edits and then merge back to master as a PR.