refactor: Restructure of dev-corner

* Restructure of dev-corner * update paintkit url * Minor fixes to the Documentation docs * Minor fixes to the Documentation docs * review fixes * link fix * rename Livery Creator section * Update dev guide and setup env * Update resources.md * Update file list * Update/fixing dev-corner pages
flybywiresim · Nov 16, 2024 · cdf9ae4 · cdf9ae4
1 parent 8227d81
commit cdf9ae4
Show file tree

Hide file tree

Showing 40 changed files with 602 additions and 322 deletions.
diff --git a/docs/FILE_LIST.md b/docs/FILE_LIST.md
@@ -1,3 +1,4 @@
+
 - [X] [FlyByWire Documentation TODOs](TODO_README.md)
     - [X] [FlyByWire Aircraft Overview](aircraft/index.md)
         - [X] [FlyByWire A32NX Overview](aircraft/a32nx/index.md)
@@ -52,29 +53,34 @@
         - [X] [Performance Tips](aircraft/support/performance-tips.md)
             - [X] [Thrustmaster T.Flight Rudder Pedal Settings](aircraft/support/detail-pages/rudder.md)
             - [X] [Reported Known Issues](aircraft/support/known-issues/index.md)
+
     - [X] [Development Corner Overview](dev-corner/index.md)
-    - [X] [Quality Assurance Process](dev-corner/qa-process.md)
-    - [X] [Tips for Scenery Developers](dev-corner/scenery-developers.md)
-    - [X] [A32NX Texture Map Changes](dev-corner/texture-changes.md)
         - [X] [Contribution Guidelines](dev-corner/dev-guide/contribute.md)
         - [X] [FlyByWire Development Guide](dev-corner/dev-guide/index.md)
+        - [X] [Quality Assurance Process](dev-corner/dev-guide/qa-process.md)
+        - [X] [Repository Structure](dev-corner/dev-guide/repository-structure.md)
         - [X] [Resources](dev-corner/dev-guide/resources.md)
         - [X] [Development Environment](dev-corner/dev-guide/setup-environment.md)
             - [X] [Best Practices](dev-corner/dev-guide/specific/bestpractices.md)
-            - [X] [flyPad Development Guide](dev-corner/dev-guide/specific/flypad-dev.md)
-            - [X] [flyPadOS 3 Localization Process](dev-corner/dev-guide/specific/flypad-translations.md)
+            - [X] [flyPad Development Guide](dev-corner/dev-guide/specific/flypad-dev-guide.md)
+            - [X] [flyPadOS 3 Localization Process](dev-corner/dev-guide/specific/flypad-localization.md)
             - [X] [Overview](dev-corner/dev-guide/specific/index.md)
-            - [X] [Instruments Build Guide](dev-corner/dev-guide/specific/instruments.md)
-            - [X] [Javascript](dev-corner/dev-guide/specific/javascript.md)
+            - [X] [Instruments Build Guide](dev-corner/dev-guide/specific/instruments-build-guide.md)
+            - [X] [Javascript](dev-corner/dev-guide/specific/javascript-dev-guide.md)
             - [X] [Code Structure](dev-corner/dev-guide/specific/structure.md)
-        - [X] [Advanced Cockpit Emulator](dev-corner/development-projects/ace.md)
-        - [X] [Sticky Discord Bot](dev-corner/development-projects/discord-bot-sticky.md)
-        - [X] [Discord Bot Version 3](dev-corner/development-projects/discord-bot-utils.md)
-        - [X] [Discord Bot Overview](dev-corner/development-projects/discord-bot.md)
-        - [X] [Overview](dev-corner/development-projects/index.md)
-        - [X] [Website Development](dev-corner/development-projects/website.md)
-            - [X] [FlyByWire Documentation Project](dev-corner/development-projects/documentation-project/documentation.md)
-            - [X] [Writing Documentation](dev-corner/development-projects/documentation-project/writing-documentation.md)
+        - [X] [FlyByWire Documentation Guide](dev-corner/documentation-guide/index.md)
+        - [X] [Writing Documentation](dev-corner/documentation-guide/writing-documentation.md)
+        - [X] [Advanced Cockpit Emulator](dev-corner/flybywire-projects/ace.md)
+        - [X] [Sticky Discord Bot](dev-corner/flybywire-projects/discord-bot-sticky.md)
+        - [X] [Discord Bot Version 3](dev-corner/flybywire-projects/discord-bot-utils.md)
+        - [X] [Discord Bot Overview](dev-corner/flybywire-projects/discord-bot.md)
+        - [X] [Overview](dev-corner/flybywire-projects/index.md)
+        - [X] [Website Development](dev-corner/flybywire-projects/website.md)
+        - [X] [A32NX Texture Map Changes](dev-corner/livery-creators/a32nx-texture-changes.md)
+        - [X] [A380X Paintkit](dev-corner/livery-creators/a380x-paintkit.md)
+        - [X] [Overview](dev-corner/localization-guide/index.md)
+        - [X] [Overview](dev-corner/other/index.md)
+        - [X] [Tips for Scenery Developers](dev-corner/other/scenery-developers.md)
     - [X] [Pilot's Corner Overview](pilots-corner/index.md)
         - [X] [Standard Operating Procedures](pilots-corner/a32nx/a32nx-sop.md)
         - [X] [Pilot's Corner A32NX Overview](pilots-corner/a32nx/index.md)
@@ -320,14 +326,13 @@
             - [X] [Overview](pilots-corner/airliner/airliner-flying-guide/overview.md)
             - [X] [Runway Conditions](pilots-corner/airliner/airliner-flying-guide/runway-conditions.md)
             - [X] [Reading METARs/TAFs/ATIS](pilots-corner/airliner/airliner-flying-guide/weather.md)
-
-
     - [X] [Release Notes - Overview](release-notes/index.md)
         - [X] [A32NX Stable Release v0.10.0](release-notes/a32nx/v0100.md)
         - [X] [A32NX Stable Release v0.10.1](release-notes/a32nx/v0101.md)
         - [X] [A32NX Stable Release v0.11.0](release-notes/a32nx/v0110.md)
         - [X] [A32NX Stable Release v0.11.1](release-notes/a32nx/v0111.md)
         - [X] [A32NX Stable Release v0.12.0](release-notes/a32nx/v0120.md)
+        - [X] [A32NX Stable Release v0.12.1](release-notes/a32nx/v0121.md)
         - [X] [A32NX Stable Release v0.7.0](release-notes/a32nx/v070.md)
         - [X] [A32NX Stable Release v0.7.1](release-notes/a32nx/v071.md)
         - [X] [A32NX Stable Release v0.7.2](release-notes/a32nx/v072.md)
@@ -340,9 +345,8 @@
         - [X] [A32NX Stable Release v0.9.0](release-notes/a32nx/v090.md)
         - [X] [A32NX Stable Release v0.9.1](release-notes/a32nx/v091.md)
         - [X] [A380X Alpha Release v0.12.0](release-notes/a380x/v0120.md)
+        - [X] [A380X Alpha Release v0.12.1](release-notes/a380x/v0121.md)
         - [X] [Installer Release v3.3.0](release-notes/installer/v330.md)
-
-
     - [X] [FlyByWire Tools Documentation](tools/index.md)
         - [X] [Installer Guide](tools/installer/index.md)
         - [X] [SimBridge](tools/simbridge/index.md)

diff --git a/docs/TODO_README.md b/docs/TODO_README.md
@@ -127,30 +127,30 @@ is good enough for now but might be improved in the future.
     - [X] [Developer Guide](dev-corner/dev-guide/index.md)
         - [X] [Overview](dev-corner/dev-guide/index.md)
         - [X] [Resources](dev-corner/dev-guide/resources.md)
+        - [X] [Repository Structure](dev-corner/dev-guide/repository-structure.md)
         - [X] [Setup Dev Environment](dev-corner/dev-guide/setup-environment.md)
-        - [ ] Repository Structure <span style="color: red;">TODO</span>
         - [X] [Contribution Guidelines](dev-corner/dev-guide/contribute.md)
         - [ ] Best Practices <span style="color: red;">TODO</span>
             - [ ] Systems Development <span style="color: red;">TODO</span>
             - [ ] Instrument Development <span style="color: red;">TODO</span>
-            - [ ] flyPad Development <span style="color: red;">TODO</span>
+            - [ ] flyPad Development <span style="color: red;">TODO - page exists but needs update</span>
         - [X] [Specific](dev-corner/dev-guide/specific/index.md)
             - [X] [Overview](dev-corner/dev-guide/specific/index.md)
-            - [X] [Instruments Build Guide](dev-corner/dev-guide/specific/instruments.md)
-            - [X] [flyPadOS 3 Localization Process](dev-corner/dev-guide/specific/flypad-translations.md) <span style="color: red;">TODO: Move to Localization Guide</span>
-            - [X] [Javascript](dev-corner/dev-guide/specific/javascript.md)
+            - [X] [Instruments Build Guide](dev-corner/dev-guide/specific/instruments-build-guide)
+            - [X] [flyPadOS 3 Localization Process](dev-corner/dev-guide/specific/flypad-localization) <span style="color: red;">TODO: Move to Localization Guide</span>
+            - [X] [Javascript](dev-corner/dev-guide/specific/javascript-dev-guide)
     - [ ] Localization Guide <span style="color: red;">TODO</span>
         - [ ] flyPad <span style="color: red;">TODO</span>
         - [ ] locPak for MSFS <span style="color: red;">TODO</span>
-    - [ ] Documentation Guide <span style="color: red;">TODO</span>
-    - [ ] Livery Creators Guide <span style="color: red;">TODO</span>
-        - [ ] A380X PaintKit <span style="color: red;">TODO</span>
-    - [ ] Other <span style="color: red;">TODO</span>
-    - [X] [FlyByWire Projects](dev-corner/development-projects/index.md)
-        - [X] [Overview](dev-corner/development-projects/index.md)
-        - [X] [Documentation Project](dev-corner/development-projects/documentation-project/documentation.md) <span style="color: red;">TODO: Move up to Documentation GUIDE</span>
-        - [X] [Website Project](dev-corner/development-projects/website.md)
-        - [X] [Discord Bot Project](dev-corner/development-projects/discord-bot.md)
+    - [X] [Livery Creators Guide](dev-corner/livery-creators/index.md)
+        - [X] [A380X PaintKit](dev-corner/livery-creators/a380x-paintkit.md)
+    - [X] [Documentation Guide](dev-corner/documentation-guide/index.md)
+    - [X] [Additional Resources](dev-corner/other/index.md)
+        - [X] [Scenery Developer Tips](dev-corner/other/scenery-developers.md)  
+    - [X] [FlyByWire Projects](dev-corner/flybywire-projects/index.md)
+        - [X] [Overview](dev-corner/flybywire-projects/index.md)
+        - [X] [Website Project](dev-corner/flybywire-projects/website.md)
+        - [X] [Discord Bot Project](dev-corner/flybywire-projects/discord-bot.md)
 
 - [X] [**FlyByWire Tools**](tools/index.md)
     - [X] [SimBridge](tools/simbridge/index.md)

diff --git a/docs/dev-corner/.pages b/docs/dev-corner/.pages
@@ -6,6 +6,9 @@
 title: Development Corner
 nav:
     - Overview: index.md
-    - A32NX Texture Changes: texture-changes.md
-    - Scenery Developers: scenery-developers.md
-    - ...
+    - Developer Guide: dev-guide
+    #- Localization Guide: localization-guide
+    - Livery Creators: livery-creators
+    - Documentation Guide: documentation-guide
+    - Other Guides: other
+    - FlyByWire Projects: flybywire-projects
diff --git a/docs/dev-corner/dev-guide/.pages b/docs/dev-corner/dev-guide/.pages
@@ -2,6 +2,8 @@ title: Development Guide
 nav:
     - Overview: index.md
     - Resources: resources.md
+    - Repository Structure: repository-structure.md
     - Setup Dev Environment: setup-environment.md
     - Contribution Guidelines: contribute.md
+    - QA Process: qa-process.md
     - Specific Topics: specific