added docs

docs/docs/index.md

@@ -0,0 +1,17 @@
+# Welcome to MkDocs
+
+For full documentation visit [mkdocs.org](https://www.mkdocs.org).
+
+## Commands
+
+* `mkdocs new [dir-name]` - Create a new project.
+* `mkdocs serve` - Start the live-reloading docs server.
+* `mkdocs build` - Build the documentation site.
+* `mkdocs -h` - Print help message and exit.
+
+## Project layout
+
+    mkdocs.yml    # The configuration file.
+    docs/
+        index.md  # The documentation homepage.
+        ...       # Other markdown pages, images and other files.

docs/docs/stylesheets/extra.css

@@ -0,0 +1,3 @@
+:root {
+    --md-primary-fg-color: #00ADD8;
+}

docs/mkdocs.yml

@@ -0,0 +1,132 @@
+site_name: sil
+theme:
+  name: material
+  palette:
+    - scheme: default
+      primary: custom
+      toggle:
+        icon: material/brightness-7
+        name: Switch to dark mode
+
+    - scheme: slate
+      primary: custom
+      toggle:
+        icon: material/brightness-4
+        name: Switch to light mode
+  features:
+    - navigation.tabs
+    - navigation.tabs.sticky
+    - navigation.sections
+    - navigation.top
+    - navigation.footer
+    - navigation.instant
+    - navigation.indexes
+    - search.suggest
+    - content.code.copy
+    - content.tooltips
+
+  icon:
+    repo: fontawesome/brands/github
+    logo: material/book-open-variant
+  favicon: assets/favicon.svg
+
+extra_css:
+  - stylesheets/extra.css
+
+copyright: Copyright © McMaster Formula Electric
+
+plugins:
+  - search
+  - spellcheck:
+      backends:  # the backends you want to use
+      - symspellpy  # as strings
+      - codespell:  # or nested configs
+          dictionaries: [clear]
+
+      # known_words can also be a list of words
+      known_words: ../includes/known_words.txt
+
+      # ignore words in <code> tags
+      ignore_code: yes
+
+      # minimum length of words to consider
+      min_length: 2
+
+      # maximum number of capital letters in a word
+      max_capital: 1
+
+      # keep unicode characters
+      allow_unicode: no
+
+      # skip files entirely (supports Unix shell-style wildcards)
+      skip_files:
+      - credits.md
+      - coverage.md
+      - reference/* 
+
+      # whether to only check in strict mode
+      strict_only: yes
+
+markdown_extensions:
+  - admonition
+  - abbr
+  - attr_list
+  - md_in_html
+  - pymdownx.details
+  - pymdownx.keys
+  - pymdownx.superfences
+  - pymdownx.inlinehilite
+  - pymdownx.tabbed:
+      alternate_style: true
+  - pymdownx.emoji:
+      emoji_index: !!python/name:material.extensions.emoji.twemoji
+      emoji_generator: !!python/name:material.extensions.emoji.to_svg
+  - pymdownx.snippets:
+      auto_append:
+        - includes/abbreviations.md
+      base_path:
+        - !relative
+        - !relative $docs_dir/../
+  - pymdownx.arithmatex:
+      generic: true 
+
+repo_url: https://github.com/macformula/hil
+repo_name: macformula/hil
+
+extra:
+  social:
+    - icon: material/web
+      link: https://macformularacing.com/
+    - icon: material/email
+      link: mailto:[email protected]
+    - icon: fontawesome/brands/github
+      link: https://github.com/macformula
+    - icon: fontawesome/brands/linkedin
+      link: https://www.linkedin.com/company/mac-formula-electric/
+    - icon: fontawesome/brands/instagram
+      link: https://www.instagram.com/macformulaelectric/
+    - icon: fontawesome/brands/facebook
+      link: https://www.facebook.com/MACFormulaElectric/
+
+nav:
+  - Home:
+    - index.md
+  - Tutorials:
+    - tutorials/index.md
+    # - tutorials/git.md
+    - tutorials/site-dev.md
+    - tutorials/wsl-can/index.md
+    - tutorials/ssh-signing/index.md
+  - Firmware:
+    - firmware/index.md
+    - firmware/dev-setup.md
+    - firmware/architecture/index.md
+    - firmware/project-structure/index.md
+    - firmware/compile-project.md
+    - firmware/flashing/index.md
+    - firmware/hw-debug.md
+    - firmware/can-traffic/index.md
+  - Glossary: glossary.md
+
+watch:
+  - includes

docs/requirements.txt

@@ -0,0 +1,2 @@
+mkdocs-material
+mkdocs-spellcheck[all]