started hil docs

docs/docs/index.md

@@ -0,0 +1,5 @@
+# McMaster Formula Electric 
+Software-in-the-loop documentation page
+
+## [:octicons-book-16: __Tutorials__](tutorials/index.md) 
+## [:octicons-trophy-16: __Mac Formula__](macfe/index.md)

docs/docs/macfe/config.md

@@ -0,0 +1,6 @@
+# Initial Configuration
+
+The `cmd/hilapp/main.go` file is the entry point to our SIL application. Compiling and running this binary will start the SIL cli.
+
+To compile the hilapp binary, navigate to the `cmd/hilapp` directory, and run `go build`
+

docs/docs/macfe/index.md

@@ -0,0 +1,4 @@
+# SIL for McMaster FE
+
+This section explains how McMaster Formula Electric uses the SIL.
+

docs/docs/macfe/run.md

@@ -0,0 +1 @@
+# Running the SIL

docs/docs/macfe/setup.md

@@ -0,0 +1,27 @@
+# Developer Setup
+
+Follow these steps to begin developing in `racecar/hil`.
+
+## Dependencies
+
+### Go
+In order to compile and run Go code, you must download Go.
+
+Go to [Go documentation](https://go.dev/doc/install) page and follow the installation guide.
+
+To verify Go is installed correctly, run:
+
+```bash
+go version
+```
+
+### gRPC
+You will need a Unix development environment (Unix machine, WSL, or remote into the Raspberry Pi).
+
+Go through the [gRPC Go Quickstart Guide](https://grpc.io/docs/languages/go/quickstart/). Build the example project.
+
+As long as you can successfully build the gRPC example and have Go installed you are ready to get started with the SIL!
+
+## Precommit setup
+
+We run `go fmt` before our code gets pushed to Github to maintain consistency. 

docs/docs/stylesheets/extra.css

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

docs/docs/tutorials/index.md

@@ -0,0 +1,2 @@
+
+[:octicons-book-16: __Quick Start__](quickstart/index.md)

docs/docs/tutorials/quickstart/index.md

@@ -0,0 +1,8 @@
+# Quick Start
+
+The `macfe/hil` package is a software-in-the-loop testing package developed in Go.
+This tutorial will walkthrough the process of using this package to set up SIL tests.
+
+
+
+## COMING SOON

docs/mkdocs.yml

@@ -0,0 +1,126 @@
+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
+  - open-in-new-tab
+  - 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/quickstart/index.md
+  - Mac Formula:
+    - macfe/index.md
+    - macfe/setup.md
+    - macfe/config.md
+    - macfe/run.md
+  - Glossary: glossary.md
+
+watch:
+  - includes

docs/requirements.txt

@@ -0,0 +1,3 @@
+mkdocs-material
+mkdocs-open-in-new-tab
+mkdocs-spellcheck[all]