flybywiresim · Steveveepee · Apr 3, 2024 · Apr 4, 2024 · Apr 4, 2024 · Apr 4, 2024
diff --git a/.gitignore b/.gitignore
@@ -1,3 +1,5 @@
+~*
+/.run/
 /.idea/
 /site/
 /.cache/

diff --git a/TODO_README.md b/TODO_README.md
@@ -0,0 +1,199 @@
+# How
+
+- avoid screenshots for now - use placeholders instead (exception is flight-deck overview)   
+  - text, dummy-image or similar A32NX images
+- do not add notes to features if available or not. These will still change a lot and we will do it 
+  shortly before release
+- otherwise use the A32NX docs as a guide for the content - if you think you can improve on the pages 
+  in the A32NX docs, feel free to do so for the A380X docs. But we recommend to not make your life 
+  unnecessarily difficult
+
+# TODO
+
+1. Navigation restructuring for multiple aircraft
+2. Content restructuring for common content for both aircraft
+3. Create scaffolding navigation for new aircraft sections
+4. Create scaffolding content for new aircraft sections
+5. Content creation for new aircraft sections in roughly this priority order:
+   1. Beginner Guide 
+   2. Update common pages to refer to both projects and aircraft 
+      - (e.g. homepage, Overview pages, FAQ, Support Guide, release notes, common questions, Install Guide, etc.)
+   3. Common Features (depending on structure) - e.g. EFB, Tiller, and such...)
+   4. List will be updated as needed
+6. Apply new CSS style to all existing pages
+
+
+## List of pages/section that need to be migrated from the A32NX docs or completed in general
+Changes have been made to this list to better reflect meeting alignment with core team and A380 team. The lists below are "MUST HAVES" before we move forward with a release pipeline (at least on the docs side of things). It will be structured as follows:
+
+- P1 - High Priority (for RC and general public)
+  - Requires assistance from dev, pilot insight, and general collaboration to get out the door.
+- P2 - Ongoing work
+  - As aircraft develops this can be done in tandem or shortly after RC and general release.
+- Docs Team - Manadatory for docs team to complete before RC and general release.
+  - Clean up and docs structure that will be handled by Docs Maintainers. Contributors can focus on content.
+
+Let's try and avoid duplication where possible.
+
+### P1
+
+- [x] Homepage (serviceable)
+- [x] FlyByWire Aircraft Overview
+- [ ] FAQ - Further Pending (Val)
+- [ ] Installation Guide - cleanup, split section if required, etc.
+  - [ ] Overview
+  - [ ] Versions
+    - Add simple versioning table
+  - [ ] Installation (TODO: Part 2)
+    - Add A380X specific installation links / steps 
+  - [x] Settings (minor changes possibly required)
+  - [ ] Liveries (TODO)
+- [ ] A32NX
+  - [x] Overview
+  - [ ] Feature Guides - split into a32nx/a380x specific features and common features
+  - [x] API
+- [ ] A380X
+  - [ ] Overview
+  - [ ] Feature Guides (need a list of available features for early documentation)
+  - [ ] Hardware Guides (Limited/Initial)
+- [ ] Pilot's Corner
+  - [x] Overview
+  - [x] A32NX Corner
+    - [ ] Beginner Guide
+      - [ ] Add Flow Patterns
+    - [x] A320X Pilot Briefing
+      - [x] Flight-Deck
+      - [x] MFD
+      - [x] PFD
+      - [ ] ND
+      - [x] EWD
+      - [x] SD
+      - [ ] FCU
+  - [ ] A380X Corner
+    - [ ] Beginner Guide - **Important** 
+    - [ ] Minor Advanced Guides? - **SEE P2**
+    - [ ] A380X Pilot Briefing - **Initial Progress Only / Coming Soon Sections Valid**
+      - [ ] Flight-Deck - Basic with all links
+      - [ ] Limitations - **IMPORTANT**
+      - [ ] MFD - Coming soon OK
+      - [ ] PFD - Coming soon OK
+      - [ ] ND - Coming Soon OK
+      - [ ] EWD - Coming soon OK
+      - [ ] SD - Coming soon OK
+      - [ ] FCU - Coming soon OK
+  - [x] Airliner Corner
+    - [x] Airliner Flying Guide
+    - [x] Terms and Abbreviations
+
+### P2
+
+- [ ] Pilot's Corner
+    - [x] Advanced Guide
+      - [ ] ... / split into a32nx/a380x specific features and common features
+  - [ ] A380X Corner
+    - [ ] Advanced Guides
+      - [ ] Add Go-Around
+      - [ ] Add OANS
+      - [ ] A380X specific features
+    - [ ] A380X Pilot Briefing - **Continue P1 Work**
+      - [ ] Flight-Deck
+      - [ ] Limitations
+      - [ ] MFD
+      - [ ] PFD
+      - [ ] ND
+      - [ ] EWD
+      - [ ] SD
+      - [ ] FCU
+- [ ] A380X
+  - [ ] API
+  - [ ] Hardware Guides (FULL)
+
+### Docs Team All Phases
+
+- [x] Update and add redirects for pages that have been moved or renamed
+- [x] Fix broken links and images
+- [ ] Support Guide - cleanup, split section if required, etc.
+- [ ] Common Features - Check structure and move if necessary. Also change into card format.
+  - [ ] EFB
+  - [ ] Tiller
+  - [ ] ...
+- [x] Release Notes
+  - [x] Overview
+  - [x] A32NX
+  - [x] A380X - No Stable yet Page is ready but hidden
+- FlyByWire Tools
+  - [x] SimBridge
+  - [x] Installer
+- [ ] Development Corner
+  - check what changes are required in this section
+    - Push that back up to P1/P2
+
+## Master List
+
+- [ ] Homepage
+- [ ] FlyByWire Aircraft Overview
+- [ ] FAQ - Further Pending (Val)
+- [ ] Installation Guide - cleanup, split section if required, etc.
+  - [ ] Overview
+  - [ ] Versions
+  - [ ] Installation (TODO: Part 2)
+  - [x] Settings
+  - [ ] Liveries (TODO)
+- [ ] Support Guide - cleanup, split section if required, etc.
+- [ ] A32NX
+  - [x] Overview
+  - [ ] Feature Guides - split into a32nx/a380x specific features and common features
+  - [x] API
+- [ ] A380X
+  - [ ] Overview
+  - [ ] Feature Guides
+  - [ ] API
+- [ ] Common Features
+  - [ ] EFB
+  - [ ] Tiller
+  - [ ] ...
+- [ ] Pilot's Corner
+  - [x] Overview
+  - [x] A32NX Corner
+    - [ ] Beginner Guide
+      - [ ] Add Flow Patterns
+    - [x] Advanced Guide
+      - [ ] ... / split into a32nx/a380x specific features and common features
+    - [x] A320X Pilot Briefing
+      - [x] Flight-Deck
+      - [x] MFD
+      - [x] PFD
+      - [ ] ND
+      - [x] EWD
+      - [x] SD
+      - [ ] FCU
+  - [ ] A380X Corner
+    - [ ] Beginner Guide
+    - [ ] Advanced Guides
+      - [ ] Add Go-Around
+      - [ ] Add OANS
+      - [ ] A380X specific features
+    - [ ] A380X Pilot Briefing
+      - [ ] Flight-Deck
+      - [ ] Limitations
+      - [ ] MFD
+      - [ ] PFD
+      - [ ] ND
+      - [ ] EWD
+      - [ ] SD
+      - [ ] FCU
+  - [x] Airliner Corner
+    - [x] Airliner Flying Guide
+    - [x] Terms and Abbreviations
+  - [ ] Development Corner
+    - check what changes are required in this section
+  - FlyByWire Tools
+    - [x] SimBridge
+    - [ ] Installer
+  - [ ] Release Notes
+    - [ ] Overview
+    - [x] A32NX
+    - [ ] A380X
+
+- [ ] Update and add redirects for pages that have been moved or renamed
+
diff --git a/WIP/index.md b/WIP/index.md
@@ -7,7 +7,7 @@ automatically download it into the proper folder. The installer will always chec
 
 Our installer also features SimBridge - our custom-built application to utilize remote tools. Check out the dedicated page for upcoming features and their status:
 
-[SimBridge](../docs/simbridge/index.md){ .md-button }
+[SimBridge](../docs/tools/simbridge/index.md){ .md-button }
 
 ---
 

diff --git a/archive/exp.md b/archive/exp.md
@@ -21,7 +21,7 @@ We are testing the new FWS (Flight Warning System) which replaces the previous p
 See technical details in the respective 
 [GitHub Pull Request #4872](https://github.com/flybywiresim/aircraft/pull/4872){target=new}.
 
-![fws-init-ecam](../docs/pilots-corner/assets/beginner-guide/starting-aircraft/fws-init-ecam.png){loading=lazy width=50%}
+![fws-init-ecam](../docs/pilots-corner/a32nx/assets/beginner-guide/starting-aircraft/fws-init-ecam.png){loading=lazy width=50%}
 
 Summary:
 
@@ -34,15 +34,15 @@ powered by the FWS truly won't work when both FWCs are unpowered or have failed.
 
 The following are features in testing that require the use of SimBridge:
 
-- [Terrain Display](../docs/simbridge/simbridge-feature-guides/terrain.md) - **Now Available on the Development Version**
+- [Terrain Display](../docs/tools/simbridge/simbridge-feature-guides/terrain.md) - **Now Available on the Development Version**
 - Remote MCDU (Web MCDU) - **Now Available on the Development Version**
-    - [Setup and Configuration Guide](../docs/simbridge/simbridge-feature-guides/remote-displays/remote-mcdu.md)
-    - [Usage Guide](../docs/simbridge/simbridge-feature-guides/remote-displays/remote-mcdu.md)
-- [Company Routes](../docs/simbridge/simbridge-feature-guides/coroute.md) - **Now Available on the Development Version**
+    - [Setup and Configuration Guide](../docs/tools/simbridge/simbridge-feature-guides/remote-displays/remote-mcdu.md)
+    - [Usage Guide](../docs/tools/simbridge/simbridge-feature-guides/remote-displays/remote-mcdu.md)
+- [Company Routes](../docs/tools/simbridge/simbridge-feature-guides/coroute.md) - **Now Available on the Development Version**
 
 !!! tip "SimBridge Information"
-    - Learn about SimBridge and further status of various features, please - [Read Here](../docs/simbridge/index.md).
-    - [SimBridge setup and configuration guide](../docs/simbridge/install-configure/configuration.md).
+    - Learn about SimBridge and further status of various features, please - [Read Here](../docs/tools/simbridge/index.md).
+    - [SimBridge setup and configuration guide](../docs/tools/simbridge/install-configure/configuration.md).
 
 ### Pause at Top of Descent (TOD)
 
@@ -137,4 +137,4 @@ the C* law, this is incorrect and will result in issues if no ADR is available.
 
 ### Download and Install
 
-See [Installation Guide](../docs/fbw-a32nx/installation.md#downloads).
+See [Installation Guide](../docs/aircraft/install/installation.md#downloads).
diff --git a/archive/flypados2/charts.md b/archive/flypados2/charts.md
@@ -1,4 +1,4 @@
-<link rel="stylesheet" href="../../../../stylesheets/efb-interactive.css">
+<link rel="stylesheet" href="/stylesheets/efb-interactive.css">
 
 # flyPad Navigation & Charts
 

diff --git a/archive/flypados2/dashboard.md b/archive/flypados2/dashboard.md
@@ -1,4 +1,4 @@
-<link rel="stylesheet" href="../../../../stylesheets/efb-interactive.css">
+<link rel="stylesheet" href="/stylesheets/efb-interactive.css">
 
 # flyPad Dashboard
 
@@ -54,7 +54,7 @@ We have applied a helpful coloring scheme a large European airline uses to point
 
 ![From simBrief](../assets/flypados2/load-from-simbrief.png)
 
-If you have [configured](settings.md) your simBrief account correctly, you can click the above button to load your last simBrief flight plan into the flyPad. This does not load the flight plan into the MCDU - you need to load it there separately (see [MCDU simBrief Integration](../../docs/pilots-corner/beginner-guide/preparing-mcdu.md#a32nx-simbrief-integration)) .
+If you have [configured](settings.md) your simBrief account correctly, you can click the above button to load your last simBrief flight plan into the flyPad. This does not load the flight plan into the MCDU - you need to load it there separately (see [MCDU simBrief Integration](../../docs/pilots-corner/a32nx/a32nx-beginner-guide/preparing-mcdu.md#a32nx-simbrief-integration)) .
 
 ### Map Zoom and Tools
 

diff --git a/archive/flypados2/dispatch.md b/archive/flypados2/dispatch.md
@@ -1,4 +1,4 @@
-<link rel="stylesheet" href="../../../../stylesheets/efb-interactive.css">
+<link rel="stylesheet" href="/stylesheets/efb-interactive.css">
 
 # flyPad Dispatch
 

diff --git a/archive/flypados2/failures.md b/archive/flypados2/failures.md
@@ -1,4 +1,4 @@
-<link rel="stylesheet" href="../../../../stylesheets/efb-interactive.css">
+<link rel="stylesheet" href="/stylesheets/efb-interactive.css">
 
 # flyPad Failures
 

diff --git a/archive/flypados2/ground.md b/archive/flypados2/ground.md
@@ -1,4 +1,4 @@
-<link rel="stylesheet" href="../../../../stylesheets/efb-interactive.css">
+<link rel="stylesheet" href="/stylesheets/efb-interactive.css">
 
 # flyPad Ground
 

diff --git a/archive/flypados2/index.md b/archive/flypados2/index.md
@@ -3,7 +3,7 @@ title: flyPadOS 2 EFB - Overview
 description: A guide the flyPadOS 2 EFB used in the Stable version of the A32NX.
 ---
 
-<link rel="stylesheet" href="../../../../stylesheets/efb-interactive.css">
+<link rel="stylesheet" href="/stylesheets/efb-interactive.css">
 <link rel="stylesheet" href="../../../../stylesheets/toc-tables.css">
 
 # flyPadOS 2 EFB

diff --git a/archive/flypados2/online-atc.md b/archive/flypados2/online-atc.md
@@ -1,4 +1,4 @@
-<link rel="stylesheet" href="../../../../stylesheets/efb-interactive.css">
+<link rel="stylesheet" href="/stylesheets/efb-interactive.css">
 
 # flyPad Online ATC
 
@@ -36,4 +36,4 @@ Go back to the ATC page and see the list of the currently available ATC stations
 
 ### Using Hoppie ACARS
 
-See documentation for [Hoppie ACARS](../../docs/fbw-a32nx/feature-guides/hoppie.md)
+See documentation for [Hoppie ACARS](../../docs/aircraft/a32nx/feature-guides/hoppie.md)
diff --git a/archive/flypados2/performance.md b/archive/flypados2/performance.md
@@ -1,12 +1,12 @@
-<link rel="stylesheet" href="../../../../stylesheets/efb-interactive.css">
+<link rel="stylesheet" href="/stylesheets/efb-interactive.css">
 
 # flyPad Performance
 
 ## Top of Descent Calculator
 
 This calculator helps the pilot to calculate when to start descending (aka the Top of Descent) based on various variables so that different scenarios can be calculated (e.g. descending with 3° descent rate, descending with a given vertical speed, etc.).
 
-For more information about descent and approach planning see our guide: [Descent and Approach Planning](../../docs/pilots-corner/beginner-guide/descent.md#1-descent-and-approach-planning)
+For more information about descent and approach planning see our guide: [Descent and Approach Planning](../../docs/pilots-corner/a32nx/a32nx-beginner-guide/descent.md#1-descent-and-approach-planning)
 
 <div style="position: relative;">
     <img src="/fbw-a32nx/assets/flypados2/flypad-performance-tod.png" style="width: 100%; height: auto;" loading="lazy">

diff --git a/archive/flypados2/settings.md b/archive/flypados2/settings.md
@@ -1,4 +1,4 @@
-<link rel="stylesheet" href="../../../../stylesheets/efb-interactive.css">
+<link rel="stylesheet" href="/stylesheets/efb-interactive.css">
 
 # flyPad Settings
 
@@ -150,15 +150,15 @@ stations and air stations. The current implementation works with fixed timings t
     - User can set the simulated boarding time to either a realistic time (~15min), a faster time (~3-4min), or instant.
         - Based on full load - 174 passengers and full cargo.
 - MCDU Keyboard Input (unrealistic)
-    - Enables the MCDU Keyboard input feature (see [MCDU Keyboard](../../docs/fbw-a32nx/feature-guides/mcdu-keyboard.md)).
+    - Enables the MCDU Keyboard input feature (see [MCDU Keyboard](../../docs/aircraft/a32nx/feature-guides/mcdu-keyboard.md)).
 - MCDU Focus Timeout (s)
     - The timeout feature will "automatically unfocus" the MCDU screen after the given amount of seconds.
     - Valid range is 5 - 120 seconds.
 - Separate Tiller from Rudder Inputs
     - User can chose to use how the nose wheel shall be controlled:
         - Legacy mode (Disabled): Rudder controls also move the nose wheel. No separation.
         - Realistic mode (Enabled): Nose Wheel steering with tiller handwheel is separate from the rudder.
-            - See our guide: [Nose Wheel and Tiller Operation](../../docs/fbw-a32nx/feature-guides/nw-tiller.md)
+            - See our guide: [Nose Wheel and Tiller Operation](../../docs/aircraft/a32nx/feature-guides/nw-tiller.md)
 - Home Cockpit Mode
     - Removes backlight bleed from PFD, ND, and ECAMs
     - Removes reflection from the ISIS
@@ -211,7 +211,7 @@ Settings for integrations with various data and information sources.
     - See [next chapter](#simbrief-integration).
 - Hoppie User ID:
     - Unique logon code that is used to identify the user for the Hoppie ACARS communication.
-    - See [Create a logon code](../../docs/fbw-a32nx/feature-guides/hoppie.md#create-a-logon-code) in our documentation for Hoppie ACARS.
+    - See [Create a logon code](../../docs/aircraft/a32nx/feature-guides/hoppie.md#create-a-logon-code) in our documentation for Hoppie ACARS.
 
 ### simBrief Integration
 
@@ -260,7 +260,7 @@ Settings for various audio sources and sounds.
 
 For detailed information on these settings please visit:
 
-[Audio Configuration Page](../../docs/fbw-a32nx/feature-guides/audio.md){.md-button}
+[Audio Configuration Page](../../docs/aircraft/a32nx/feature-guides/audio.md){.md-button}
 
 ## flyPad Settings
-Original file line number
+Diff line change
@@ -1,3 +1,5 @@
+    ~*
+    /.run/
     /.idea/
     /site/
     /.cache/
@@ Expand Down @@