1
0
forked from me/IronOS

Generate a mkdocs github page + Migrate documentation links to use it (#1414)

* Approx first pass?

* Update docs.yml

* Filling out menu

* Update GettingStarted.md

* Index docs links

* Update index.md

* Update README.md

* Link redirection

* More link rewrite

* Update HallSensor.md

* Split up flashing

* Derp

* Flashing links
This commit is contained in:
Ben V. Brown
2022-09-22 13:10:01 +10:00
committed by GitHub
parent c89db78b45
commit 6fab3e5252
17 changed files with 742 additions and 304 deletions

30
mkdocs.yml Normal file
View File

@@ -0,0 +1,30 @@
site_name: IronOS
site_url: https://ralim.github.io/IronOS/
repo_url: https://github.com/ralim/IronOS/
site_description: "IronOS Open Source Soldering Iron firmware for Miniware and Pinecil"
docs_dir: Documentation
nav:
- Home: index.md
- Getting Started: GettingStarted.md
- Flashing the firmware:
- MHP30: Flashing/MHP30.md
- Pinecil V1: Flashing/Pinecil V1.md
- Pinecil V2: Flashing/Pinecil V2.md
- TS80(P): Flashing/TS80(P).md
- TS100: Flashing/TS100.md
- Operation:
- Main Menu: Menu.md
- Settings: Settings.md
- Debug Menu: DebugMenu.md
- Power: Power.md
- Temperature: Temperature.md
- Startup Logo: Logo.md
- Hardware:
- Hall Sensor (Pinecil): HallSensor.md
- Hardware Notes: Hardware.md
- Troubleshooting: Troubleshooting.md
- Known Hardware Issues: HardwareIssues.md
- Translations: Translation.md
- Development: Development.md
theme: readthedocs