🔀 Merge branch 'main' into stable

.github/CONTRIBUTING.md

@@ -29,7 +29,7 @@ All types of contributions are encouraged and valued. See the [Table of Contents
 
 ## I Have a Question
 
-> If you want to ask a question, we assume that you have read the available [Documentation](../docs.pdf).
+> If you want to ask a question, we assume that you have read the available [Documentation](https://the-notebookinator.github.io/notebookinator/).
 
 Before you ask a question, it is best to search for existing [Issues](https://github.com/BattleCh1cken/notebookinator.git/issues) that might help you. In case you have found a suitable issue and still need clarification, you can write your question in this issue. It is also advisable to search the internet for answers first.
 
@@ -41,21 +41,6 @@ If you then still feel the need to ask a question and need clarification, we rec
 
 We will then take care of the issue as soon as possible.
 
-<!--
-You might want to create a separate issue tag for questions and include it in this description. People should then tag their issues accordingly.
-
-Depending on how large the project is, you may want to outsource the questioning, e.g. to Stack Overflow or Gitter. You may add additional contact and information possibilities:
-- IRC
-- Slack
-- Gitter
-- Stack Overflow tag
-- Blog
-- FAQ
-- Roadmap
-- E-Mail List
-- Forum
--->
-
 ## I Want To Contribute
 
 > ### Legal Notice <!-- omit in toc -->
@@ -153,16 +138,34 @@ You can then [commit](#commit-messages) your changes to your fork. Once you are
 
 ### Improving The Documentation
 
-We use [Tidy](https://github.com/Mc-Zen/tidy/tree/main) to generate our documentation. This means that most of our documentation is written directly in the code as comments.
+We use a combination of [mdBook](https://github.com/rust-lang/mdBook) and [Tidy](https://github.com/Mc-Zen/tidy/tree/main) to generate our documentation.
 
-You can improve the documentation in the following places:
+All of the documentation can be found inside of the [`docs/`](../docs) directory.
 
+- The guides located in [`docs/src/`](../docs/src)
 - The comments directly in the code
-- The documentation in [`docs.typ`](../docs.typ)
-- The template for the docs at [`docs-template.typ`](../docs-template.typ)
 - The [README](../README.md)
 - The [contributing guide](./CONTRIBUTING.md)(this file)
 
+You can preview your changes locally with the mdbook cli. The first thing you'll need to do is install all of the dependences.
+
+```bash
+cargo install --git https://github.com/typst/typst --locked typst-cli
+cargo install mdbook
+cargo install mdbook-admonish
+cargo install --git https://github.com/fenjalien/mdbook-typst-doc.git
+```
+
+Once everything has installed, render the documentation with these commands:
+
+```bash
+typst compile docs/src/reference.typ --root ./
+cd docs
+mdbook serve
+```
+
+You can then view your notebook by visiting <localhost:8000>.
+
 Once you've made your changes, submit your changes as a pull request, as described above.
 
 ## Style Guides

.github/workflows/ci.yml

@@ -23,6 +23,5 @@ jobs:
       - name: Run checks
         run: |
           just install
-          just docs
           just gallery
           # TODO: run unit tests here

.gitignore

@@ -12,3 +12,6 @@ gallery/*.png
 !gallery/linear-03.png
 !gallery/linear-04.png
 !gallery/linear-05.png
+
+docs/book
+docs/src/reference.pdf

README.md

@@ -16,7 +16,7 @@
 
 This is the Notebookinator, a [Typst](https://github.com/typst/typst) template designed for the Vex Robotics Competition. This template aims to make it as easy as possible to get you up and running with a clean and organized notebooking environment, with minimal overhead. It provides multiple themes, and can even be extended with your own.
 
-To get started, read the [documentation](./docs.pdf). If you have questions, or just want to hang out, feel free to join our [Discord server](https://discord.gg/sUpcVPtBDg).
+To get started, read the [documentation](https://the-notebookinator.github.io/notebookinator/). If you have questions, or just want to hang out, feel free to join our [Discord server](https://discord.gg/sUpcVPtBDg).
 
 ## Gallery