renamed files for ovos-doc-viewer compat (#80)

* renamed files for ovos-doc-viewer compat Added missing pages * Left room for more docs
OpenVoiceOS · Nov 12, 2023 · b8366bf · b8366bf
1 parent 3e07f11
commit b8366bf
Show file tree

Hide file tree

Showing 61 changed files with 77 additions and 67 deletions.
diff --git a/docs/index.md → docs/000-index.md b/docs/index.md → docs/000-index.md
diff --git a/docs/about.md → docs/001-about.md b/docs/about.md → docs/001-about.md
diff --git a/docs/hardware.md → docs/010-hardware.md b/docs/hardware.md → docs/010-hardware.md
diff --git a/docs/hardware_audio.md → docs/011-hardware_audio.md b/docs/hardware_audio.md → docs/011-hardware_audio.md
diff --git a/docs/hardware_video.md → docs/012-hardware_video.md b/docs/hardware_video.md → docs/012-hardware_video.md
diff --git a/docs/architecture.md → docs/020-architecture.md b/docs/architecture.md → docs/020-architecture.md
diff --git a/docs/qs_intro.md → docs/030-qs_intro.md b/docs/qs_intro.md → docs/030-qs_intro.md
diff --git a/docs/qs_first_boot.md → docs/031-qs_first_boot.md b/docs/qs_first_boot.md → docs/031-qs_first_boot.md
diff --git a/docs/qs_next_steps.md → docs/032-qs_next_steps.md b/docs/qs_next_steps.md → docs/032-qs_next_steps.md
diff --git a/docs/install_intro.md → docs/040-install_intro.md b/docs/install_intro.md → docs/040-install_intro.md
diff --git a/docs/install_ovos_core.md → docs/042-install_ovos_core.md b/docs/install_ovos_core.md → docs/042-install_ovos_core.md
diff --git a/docs/install_ovos_docker.md → docs/043-install_ovos_docker.md b/docs/install_ovos_docker.md → docs/043-install_ovos_docker.md
diff --git a/docs/install_gui.md → docs/044-install_gui.md b/docs/install_gui.md → docs/044-install_gui.md
diff --git a/docs/starting_intro.md → docs/050-starting_intro.md b/docs/starting_intro.md → docs/050-starting_intro.md
diff --git a/docs/starting_modules.md → docs/051-starting_modules.md b/docs/starting_modules.md → docs/051-starting_modules.md
diff --git a/docs/starting_systemd.md → docs/052-starting_systemd.md b/docs/starting_systemd.md → docs/052-starting_systemd.md
diff --git a/docs/053-starting_docker.md b/docs/053-starting_docker.md
@@ -0,0 +1,7 @@
+# Starting OVOS - docker
+
+Take a look at the [dedicated OVOS container documentation](https://openvoiceos.github.io/ovos-docker/)
+
+There you will find a very comprehensive guide to running [OVOS with docker](https://github.com/OpenVoiceOS/ovos-docker)
+
+And the newest addition is an [installer script](https://github.com/OpenVoiceOS/ovos-installer) that will guide you through the docker installation.
diff --git a/docs/config.md → docs/060-config.md b/docs/config.md → docs/060-config.md
diff --git a/docs/config_ovos_config.md → docs/061-config_ovos_config.md b/docs/config_ovos_config.md → docs/061-config_ovos_config.md
diff --git a/docs/config_manual_config.md → docs/062-config_manual_config.md b/docs/config_manual_config.md → docs/062-config_manual_config.md
diff --git a/docs/ht_intro.md → docs/070-ht_intro.md b/docs/ht_intro.md → docs/070-ht_intro.md
diff --git a/docs/ht_skills.md → docs/080-ht_skills.md b/docs/ht_skills.md → docs/080-ht_skills.md
diff --git a/docs/ht_skills_install.md → docs/081-ht_skills_install.md b/docs/ht_skills_install.md → docs/081-ht_skills_install.md
diff --git a/docs/ht_skills_config.md → docs/082-ht_skills_config.md b/docs/ht_skills_config.md → docs/082-ht_skills_config.md
diff --git a/docs/ht_tts.md → docs/090-ht_tts.md b/docs/ht_tts.md → docs/090-ht_tts.md
diff --git a/docs/ht_tts_config.md → docs/091-ht_tts_config.md b/docs/ht_tts_config.md → docs/091-ht_tts_config.md
diff --git a/docs/ht_change_voice.md → docs/092-ht_change_voice.md b/docs/ht_change_voice.md → docs/092-ht_change_voice.md
diff --git a/docs/ht_listener_intro.md → docs/100-ht_listener_intro.md b/docs/ht_listener_intro.md → docs/100-ht_listener_intro.md
diff --git a/docs/ht_mic.md → docs/101-ht_mic.md b/docs/ht_mic.md → docs/101-ht_mic.md
diff --git a/docs/ht_stt.md → docs/102-ht_stt.md b/docs/ht_stt.md → docs/102-ht_stt.md
diff --git a/docs/ht_stt_config.md → docs/103-ht_stt_config.md b/docs/ht_stt_config.md → docs/103-ht_stt_config.md
diff --git a/docs/ht_ww.md → docs/104-ht_ww.md b/docs/ht_ww.md → docs/104-ht_ww.md
@@ -5,6 +5,8 @@ OVOS "hotwords" is the configuration section to specify what the WakeWord do.  M
 
 As with everything else, this too can be changed, and several plugins are available.  Some work better than others.
 
+[Mike Grey](https://blog.graywind.org/) created a great [blog post](https://blog.graywind.org/posts/neon-change-wakeword/) about the WakeWords also.
+
 ## List of OVOS WakeWord Plugins
 | Plugin                                 | Type     | Description                           |
 |----------------------------------------|----------|----------------------------|

diff --git a/docs/ht_vad.md → docs/105-ht_vad.md b/docs/ht_vad.md → docs/105-ht_vad.md
diff --git a/docs/ht_phal.md → docs/110-ht_phal.md b/docs/ht_phal.md → docs/110-ht_phal.md
diff --git a/docs/ht_config_homescreen.md → docs/115-ht_config_homescreen.md b/docs/ht_config_homescreen.md → docs/115-ht_config_homescreen.md
diff --git a/docs/ht_config_security.md → docs/118-ht_config_security.md b/docs/ht_config_security.md → docs/118-ht_config_security.md
diff --git a/docs/selene_backend.md → docs/120-selene_backend.md b/docs/selene_backend.md → docs/120-selene_backend.md
@@ -2,6 +2,3 @@
 The Mycroft Selene backend is deprecated but the software has been made avaliable on github.
 
 https://github.com/MycroftAI/selene-backend
-
-**Coming Soon**
-Installing your own Selene backend
diff --git a/docs/personal_backend.md → docs/121-personal_backend.md b/docs/personal_backend.md → docs/121-personal_backend.md
diff --git a/docs/kdeconnect.md → docs/122-kdeconnect.md b/docs/kdeconnect.md → docs/122-kdeconnect.md
diff --git a/docs/images_intro.md → docs/130-images_intro.md b/docs/images_intro.md → docs/130-images_intro.md
diff --git a/docs/images_buildroot.md → docs/131-images_buildroot.md b/docs/images_buildroot.md → docs/131-images_buildroot.md
diff --git a/docs/mycroft.md → docs/135-mycroft.md b/docs/mycroft.md → docs/135-mycroft.md
diff --git a/docs/neonos.md → docs/136-neonos.md b/docs/neonos.md → docs/136-neonos.md
diff --git a/docs/troubleshooting_intro.md → docs/140-troubleshooting_intro.md b/docs/troubleshooting_intro.md → docs/140-troubleshooting_intro.md
diff --git a/docs/troubleshooting_audio.md → docs/145-troubleshooting_audio.md b/docs/troubleshooting_audio.md → docs/145-troubleshooting_audio.md
diff --git a/docs/troubleshooting_installation.md → docs/150-troubleshooting_installation.md b/docs/troubleshooting_installation.md → docs/150-troubleshooting_installation.md
diff --git a/docs/troubleshooting_network.md → docs/155-troubleshooting_network.md b/docs/troubleshooting_network.md → docs/155-troubleshooting_network.md
diff --git a/docs/troubleshooting_wakeword.md → docs/160-troubleshooting_wakeword.md b/docs/troubleshooting_wakeword.md → docs/160-troubleshooting_wakeword.md
diff --git a/docs/troubleshooting_ovos_core.md → docs/165-troubleshooting_ovos_core.md b/docs/troubleshooting_ovos_core.md → docs/165-troubleshooting_ovos_core.md
diff --git a/docs/troubleshooting_backend.md → docs/170-troubleshooting_backend.md b/docs/troubleshooting_backend.md → docs/170-troubleshooting_backend.md
diff --git a/docs/troubleshooting_tts.md → docs/175-troubleshooting_tts.md b/docs/troubleshooting_tts.md → docs/175-troubleshooting_tts.md
diff --git a/docs/troubleshooting_stt.md → docs/180-troubleshooting_stt.md b/docs/troubleshooting_stt.md → docs/180-troubleshooting_stt.md
diff --git a/docs/troubleshooting_skills.md → docs/185-troubleshooting_skills.md b/docs/troubleshooting_skills.md → docs/185-troubleshooting_skills.md
diff --git a/docs/troubleshooting_plugins.md → docs/190-troubleshooting_plugins.md b/docs/troubleshooting_plugins.md → docs/190-troubleshooting_plugins.md
diff --git a/docs/glossary.md → docs/300-glossary.md b/docs/glossary.md → docs/300-glossary.md
diff --git a/docs/faq.md → docs/305-faq.md b/docs/faq.md → docs/305-faq.md
diff --git a/docs/310-compat.md b/docs/310-compat.md
@@ -0,0 +1,3 @@
+# OVOS Compatability
+
+**WIP Coming Soon**
diff --git a/docs/license.md → docs/315-license.md b/docs/license.md → docs/315-license.md
diff --git a/docs/friends.md → docs/320-friends.md b/docs/friends.md → docs/320-friends.md
diff --git a/docs/members.md → docs/325-members.md b/docs/members.md → docs/325-members.md
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -2,80 +2,81 @@ site_name: OVOS User Documentation
 site_url: https://openvoiceos.github.io/community-docs
 nav:
     - Home:
-        - Introduction: index.md
-        - About: about.md
-        - Supported Hardware: 
-            - Introduction: hardware.md
-            - Audio: hardware_audio.md
-            - Video: hardware_video.md
-        - OpenVoiceOS Architecture: architecture.md
+        - Introduction: 000-index.md
+        - About: 001-about.md
+        - Supported Hardware:
+            - Introduction: 010-hardware.md
+            - Audio: 011-hardware_audio.md
+            - Video: 012-hardware_video.md
+        - OpenVoiceOS Architecture: 020-architecture.md
     - Quick Start Guide:
-        - Introduction: qs_intro.md
-        - First Boot: qs_first_boot.md
-        - Next Steps: qs_next_steps.md
+        - Introduction: 030-qs_intro.md
+        - First Boot: 031-qs_first_boot.md
+        - Next Steps: 032-qs_next_steps.md
     - Installation Options:
-        - Introduction: install_intro.md
-        - Installing an Image: qs_intro.md
-        - Install as a Library: install_ovos_core.md
-        - Install with Docker: install_ovos_docker.md
-        - Install GUI: install_gui.md
+        - Introduction: 040-install_intro.md
+        - Installing an Image: 030-qs_intro.md
+        - Install as a Library: 042-install_ovos_core.md
+        - Install with Docker: 043-install_ovos_docker.md
+        - Install GUI: 044-install_gui.md
     - Starting OVOS:
-        - Introduction: starting_intro.md
-        - Starting Modules: starting_modules.md
-        - Starting Systemd: starting_systemd.md
-        - Starting Docker: starting_docker.md
+        - Introduction: 050-starting_intro.md
+        - Starting Modules: 051-starting_modules.md
+        - Starting Systemd: 052-starting_systemd.md
+        - Starting Docker: 053-starting_docker.md
     - Configuration:
-        - Introduction: config.md
-        - Using ovos-config: config_ovos_config.md
-        - Manualy Editing Files: config_manual_config.md
+        - Introduction: 060-config.md
+        - Using ovos-config: 061-config_ovos_config.md
+        - Manualy Editing Files: 062-config_manual_config.md
     - How To:
-        - Introduction: ht_intro.md
+        - Introduction: 070-ht_intro.md
         - Skills:
-            - Introduction: ht_skills.md
-            - Installing Skills: ht_skills_install.md
-            - Configuring: ht_skills_config.md
-        - TTS: 
-            - Introduction: ht_tts.md
-            - Configuring: ht_tts_config.md
-            - Change Your Assistant's Voice: ht_change_voice.md
-        - Listener: 
-            - Introduction: ht_listener_intro.md
-            - Microphone: ht_mic.md
-            - STT: ht_stt.md
-            - WakeWord/HotWords: ht_ww.md
-            - VAD: ht_vad.md
-        - PHAL: ht_phal.md
+            - Introduction: 080-ht_skills.md
+            - Installing Skills: 081-ht_skills_install.md
+            - Configuring: 082-ht_skills_config.md
+        - TTS:
+            - Introduction: 090-ht_tts.md
+            - Configuring: 091-ht_tts_config.md
+            - Change Your Assistant's Voice: 092-ht_change_voice.md
+        - Listener:
+            - Introduction: 100-ht_listener_intro.md
+            - Microphone: 101-ht_mic.md
+            - STT: 102-ht_stt.md
+                - Configuring: 103-ht_stt_config.md
+            - WakeWord/HotWords: 104-ht_ww.md
+            - VAD: 105-ht_vad.md
+        - PHAL: 110-ht_phal.md
         - Homescreen:
-            - Configuration: ht_config_homescreen.md
-        - OpenVoiceOS Security: ht_config_security.md
+            - Configuration: 115-ht_config_homescreen.md
+        - OpenVoiceOS Security: 118-ht_config_security.md
     - Additional Services:
-        - Selene Backend: selene_backend.md
-        - Personal Backend: personal_backend.md
-        - KDE Connect: kdeconnect.md
+        - Selene Backend: 120-selene_backend.md
+        - Personal Backend: 121-personal_backend.md
+        - KDE Connect: 122-kdeconnect.md
     - Images:
-        - Introduction: images_intro.md
-        - Buildroot: images_buildroot.md
-        - Raspbian: install_raspbian.md
+        - Introduction: 130-images_intro.md
+        - Buildroot: 131-images_buildroot.md
+        - Raspbian: 030-qs_intro.md
     - Other Builds:
-        - Mycroft: mycroft.md
-        - NeonOS: neonos.md
+        - Mycroft: 135-mycroft.md
+        - NeonOS: 136-neonos.md
     - Troubleshooting:
-          - Introduction to Troubleshooting: troubleshooting_intro.md
-          - Troubleshooting Audio: troubleshooting_audio.md
-          - Troubleshooting Installation: troubleshooting_installation.md
-          - Troubleshooting Network: troubleshooting_network.md
-          - Troubleshooting Wakeword: troubleshooting_wakeword.md
-          - Troubleshooting OVOS Core: troubleshooting_ovos_core.md
-          - Troubleshooting Backend: troubleshooting_backend.md
-          - Troubleshooting TTS: troubleshooting_tts.md
-          - Troubleshooting STT: troubleshooting_stt.md
-          - Troubleshooting Skills: troubleshooting_skills.md
-          - Troubleshooting Plugins: troubleshooting_plugins.md
+          - Introduction to Troubleshooting: 140-troubleshooting_intro.md
+          - Troubleshooting Audio: 145-troubleshooting_audio.md
+          - Troubleshooting Installation: 150-troubleshooting_installation.md
+          - Troubleshooting Network: 155-troubleshooting_network.md
+          - Troubleshooting Wakeword: 160-troubleshooting_wakeword.md
+          - Troubleshooting OVOS Core: 165-troubleshooting_ovos_core.md
+          - Troubleshooting Backend: 170-troubleshooting_backend.md
+          - Troubleshooting TTS: 175-troubleshooting_tts.md
+          - Troubleshooting STT: 180-troubleshooting_stt.md
+          - Troubleshooting Skills: 185-troubleshooting_skills.md
+          - Troubleshooting Plugins: 190-troubleshooting_plugins.md
     - Appendix:
-        - Glossary: glossary.md
-        - FAQ: faq.md
-        - Compatibility: compat.md
-        - License: license.md
-        - Friends: friends.md
-        - OVOS Members: members.md
+        - Glossary: 300-glossary.md
+        - FAQ: 305-faq.md
+        - Compatibility: 310-compat.md
+        - License: 315-license.md
+        - Friends: 320-friends.md
+        - OVOS Members: 325-members.md
 theme: readthedocs