Initial config page

MtnMesh · Oct 6, 2024 · 8a9d103 · 8a9d103
1 parent c33ee17
commit 8a9d103
Show file tree

Hide file tree

Showing 5 changed files with 74 additions and 14 deletions.
diff --git a/docs/config.md b/docs/config.md
@@ -0,0 +1,52 @@
+---
+status: new
+---
+
+# Recommended Configuration Settings
+
+
+## Radio configuration
+
+=== "Device"
+
+    |                      Option | Recommended Config        | Notes                                                                                                           |
+    | --------------------------: | :------------------------ | :-------------------------------------------------------------------------------------------------------------- |
+    |                        Role | `CLIENT` or `CLIENT_MUTE` | See :fontawesome-brands-youtube: [Meshtastic Deployment Scenarios](https://www.youtube.com/watch?v=htjwtnjQkkE) |
+    | NodeInfo broadcast interval | `10800` (3 hours)         |                                                                                                                 |
+
+=== "Position"
+
+    |                      Option | Recommended Config   | Notes                                          |
+    | --------------------------: | :------------------- | :--------------------------------------------- |
+    |      Smart position enabled | `True`               |                                                |
+    | Position broadcast interval | `3600` (1 hour)      |                                                |
+    |         GPS update interval | `1800` (30 minutes)  |                                                |
+    |              Position flags | Disable unused flags | Fixed nodes should disable almost all of these |
+
+=== "LoRa"
+
+    |      Option | Recommended Config |
+    | ----------: | :----------------- |
+    |   Hop limit | `5`                |
+    | Ignore MQTT | `True`             |
+    |  OK to MQTT | `False`            |
+
+## Module configuration
+
+=== "Telemetry"
+
+    |                              Option | Recommended Config | Notes                                                     |
+    | ----------------------------------: | :----------------- | :-------------------------------------------------------- |
+    |      Device metrics update interval | `3600` (1 hour)    | Change to `1800` when testing new nodes                   |
+    | Environment metrics update interval | `3600` (1 hour)    |                                                           |
+    |        Power metrics module enabled | `False`            | This is for I²C power monitors, not onboard battery stats |
+
+    Consider disabling the `Environment metrics` / `Air Quality metrics` modules if you are not using the data.
+
+
+=== "Neighbor Info"
+
+    |                Option | Recommended Config |
+    | --------------------: | :----------------- |
+    | Neighbor Info enabled | `True`             |
+    |       Update interval | `21600` (6 hours)  |
diff --git a/docs/guides.md b/docs/guides.md
diff --git a/docs/guides/guide1.md b/docs/guides/guide1.md
@@ -0,0 +1,5 @@
+---
+status: new
+---
+
+## Guide 1
diff --git a/docs/index.md b/docs/index.md
@@ -5,10 +5,14 @@ status: new
 # MtnMe.sh
 Mountain Mesh: Serving Meshtastic to the Appalachian Mountains.
 
-This site is a work in progress, feel free to submit a PR!
+[Join us on Discord!](https://discord.gg/4WN32RHGSs)
+
+[![Discord Widget](https://discord.com/api/guilds/1280880869296570368/widget.png?style=banner3)](https://discord.gg/4WN32RHGSs)
 
 ## MeshInfo
 
 Checkout the mesh in real time on [our MeshInfo](https://info.MtnMe.sh) -- Best viewed on Desktop.
 
 ![MtnMe.sh MeshInfo Map](static/meshinfo_map.png)
+
+This site is a work in progress, feel free to submit a PR!
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -8,7 +8,9 @@ edit_uri: edit/main/docs/
 nav:
   - Home: index.md
   - About: about.md
-  - Guides: guides.md
+  - Guides:
+    # - Guide1: guides/guide1.md
+    - Config: config.md
   - Devices: devices.md
   - Resources: resources.md
   - Neighbors: neighbors.md
@@ -17,16 +19,24 @@ plugins:
   - search
   - social
   - git-revision-date-localized:
-      enable_creation_date: true
+      enable_creation_date: false
       type: date
   - git-committers:
       repository: MtnMesh/mtnmesh.github.io
       branch: main
 
 markdown_extensions:
+  - toc
+  - attr_list
   - tables
+  - pymdownx.superfences
+  - pymdownx.tabbed:
+      alternate_style: true
   - pymdownx.tasklist:
       custom_checkbox: true
+  - pymdownx.emoji:
+      emoji_index: !!python/name:material.extensions.emoji.twemoji 
+      emoji_generator: !!python/name:material.extensions.emoji.to_svg
 
 theme:
   name: material