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

scripts/IronOS-mkdocs.yml

@@ -3,19 +3,21 @@ site_name: IronOS
 site_url: https://ralim.github.io/IronOS/
 site_description: "IronOS Open Source Soldering Iron firmware for Miniware and Pinecil"
 
-# repo config
+# Repo config
 repo_url: https://github.com/ralim/IronOS/
 
+# Dir & location config
 docs_dir: ../Documentation
 edit_uri: edit/dev/Documentation/
 
 # Theme and config
-theme: 
+theme:
     name: readthedocs
     highlightsjs: true
     hljs_languages:
         - yaml
 
+# Navigation structure
 nav:
   - Home: index.md
   - Getting Started: GettingStarted.md
@@ -39,7 +41,7 @@ nav:
       - Known Hardware Issues: HardwareIssues.md
   - Translations: Translation.md
   - Development: Development.md
-  
+
 # Plugins
 plugins:
   - search
@@ -47,7 +49,6 @@ plugins:
   - awesome-pages
   - git-revision-date
 
-
 # Markdown Extensions
 markdown_extensions:
   - attr_list