mirror of
https://github.com/Ralim/IronOS.git
synced 2025-02-26 07:53:55 +00:00
Implement autogeneration of Documentation/README.md (#1738)
* mkdocs.yml: unify formatting style * Docs/README.md: add auto-generated README.md file for Documentation/ directory * Docs/README.md: fix refs * Docs/README.md: fix locations * Docs/README.md: trying workaround spaces in filenames for refs * Documentation/README.md: update generated file trying to fix all formatting issues * Documentation/README.md: reduce title size * Documentation/README.md: add link for official online docs * scripts/deploy.sh: implement docs_readme function * deploy.sh: add overwrite warning in help output * deploy.sh: try to fix shellcheck warnings * deploy.sh:docs_readme() - show note message only if README should be updated * deploy.sh:docs_readme() - fix shellcheck * github/push: add Documentation/README.md check * github/push: force usage of /bin/sh for deploy.sh script * testing, testing, testing * deploy.sh:docs_readme() - make error-related message more clear about what to donext * Revert change used only to test failure on github CI
This commit is contained in:
29
Documentation/README.md
Normal file
29
Documentation/README.md
Normal file
@@ -0,0 +1,29 @@
|
||||
|
||||
<!-- THIS FILE IS AUTOGENERATED by "scripts/deploy.sh docs_readme" based on nav section in scripts/IronOS-mkdocs.yml config -->
|
||||
<!-- THIS FILE IS NOT SUPPOSED TO BE EDITED MANUALLY -->
|
||||
|
||||
#### This is autogenerated README for brief navigation through github over official documentation for IronOS project
|
||||
#### This documentation is also available [here online](https://ralim.github.io/IronOS)
|
||||
|
||||
- [Home](../Documentation/index.md)
|
||||
- [Getting Started](../Documentation/GettingStarted.md)
|
||||
- Flashing the firmware
|
||||
- [MHP30](../Documentation/Flashing/MHP30.md)
|
||||
- [Pinecil V1](../Documentation/Flashing/Pinecil%20V1.md)
|
||||
- [Pinecil V2](../Documentation/Flashing/Pinecil%20V2.md)
|
||||
- [TS80(P)](../Documentation/Flashing/TS80(P).md)
|
||||
- [TS100](../Documentation/Flashing/TS100.md)
|
||||
- Operation
|
||||
- [Main Menu](../Documentation/Menu.md)
|
||||
- [Settings](../Documentation/Settings.md)
|
||||
- [Debug Menu](../Documentation/DebugMenu.md)
|
||||
- [Power](../Documentation/Power.md)
|
||||
- [Temperature](../Documentation/Temperature.md)
|
||||
- [Startup Logo](../Documentation/Logo.md)
|
||||
- Hardware
|
||||
- [Hall Sensor (Pinecil)](../Documentation/HallSensor.md)
|
||||
- [Hardware Notes](../Documentation/Hardware.md)
|
||||
- [Troubleshooting](../Documentation/Troubleshooting.md)
|
||||
- [Known Hardware Issues](../Documentation/HardwareIssues.md)
|
||||
- [Translations](../Documentation/Translation.md)
|
||||
- [Development](../Documentation/Development.md)
|
||||
Reference in New Issue
Block a user