From 405c35a67956ab4264fcd980c34d165ef7189243 Mon Sep 17 00:00:00 2001 From: Frank Kopp Date: Fri, 1 Nov 2024 14:38:55 +0100 Subject: [PATCH] docs: Clean up TODO and small fixes (#1035) * Clean up TODO and small fixes * Adding a file list script and updating TODO * Adding a file list script and updating TODO --- TODO_README.md | 245 -------------------- docs/FILE_LIST.md | 361 ++++++++++++++++++++++++++++++ docs/TODO_README.md | 158 +++++++++++++ docs/aircraft/support/.pages | 3 +- docs/pilots-corner/a380x/index.md | 22 +- docs/update_filelist.py | 76 +++++++ 6 files changed, 603 insertions(+), 262 deletions(-) delete mode 100644 TODO_README.md create mode 100644 docs/FILE_LIST.md create mode 100644 docs/TODO_README.md create mode 100644 docs/update_filelist.py diff --git a/TODO_README.md b/TODO_README.md deleted file mode 100644 index 3f0cb2c8f..000000000 --- a/TODO_README.md +++ /dev/null @@ -1,245 +0,0 @@ -## 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) -- [x] Installation Guide - cleanup, split section if required, etc. - - [ ] Overview **REQURIES FINAL LINKS** - - [x] Versions - - Add simple versioning table - - [x] Installation (TODO: Part 2) - - Add A380X specific installation links / steps - - [x] Settings (minor changes possibly required) -- [x] A32NX - - [x] Overview - - [x] Feature Guides - split into a32nx/a380x specific features and common features - - [x] API -- [ ] A380X - - [x] Overview - Interim Docs Started - - [x] Feature Guides (need a list of available features for early documentation) - - SimBrief Integration - - Flight Planning - - Loading and Fueling - - [ ] Hardware Guides - **Coming Soon OK (Limited/Initial)** -- [ ] Pilot's Corner - - [x] Overview - - [x] A32NX Corner - - [x] Beginner Guide - Keeping the Same - - [ ] Add Flow Patterns - **Optional** - - [x] A320X Pilot Briefing - - [x] Flight-Deck - - [x] MFD - - [x] PFD - - [ ] ND - - [x] EWD - - [x] SD - - [ ] FCU - - [ ] A380X Corner - - [ ] Beginner Guide - **REVIEW** - - [ ] 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 - -#### P1 Additional for Beginning Guide -Section is for additional content to match P1 requirements for **Beginner Guide Specifically**. - -**Overview** -- [X] Overview page for the A380X Beginner Guide - -**Preflight** -Minor internal linking requirements and restructuring. - -- [x] SimBrief guide needs update + New Page -- [ ] Discontinuities - - [ ] Has a page in A380X corner needs updates - - How is this handled? -- [x] Payload Management - - [ ] Fuel and weight - needs guide + new page - -**Cockpit Preparation** - -Pre-Checks -- [ ] Flight Deck Overview Link (Add) - -Initial Power Up -- [ ] Image of how to do so (overhead → See Panels) - -Fire Test and APU Startup -- [ ] Location - -**Panels** - -Requires images in block format for each specific module to include in the cockpit preparation (can be reused later but would be handy to have. - -Can see the requirements in the A380X pilot briefing. **All Modules In block format** - -- [ ] Overhead Panel - - [ ] Left - - [ ] Center - - [ ] Right -- [ ] Main Instrument Panel -- [ ] Pedestal -- [ ] Glareshield -- [ ] Lateral Consoles - -Takeoff Briefing - -- [ ] Need before runway Image -- [ ] Vertical and Lateral Guidance on PFD Image -- [ ] A380X speedband with V speeds -- [ ] FCU standard screenshot - -Preparing FMS -Straks should be preparing this - -Descent Planning - -- [ ] Verify Landing Calc Present in FMS - use simbrief UPDATE NOTICE -- [ ] BTV Documentation Written -- [ ] Remove notice to update links in V/S not recommended - -Landing - -- [ ] Update aircraft exterior screenshot exiting runway entry markers with full length of the aircraft - -After Landing + Powering Down - -- [ ] Repeat of imagery based on landing - - -### P2 - -All advance guides currently need to be re-written / split up / copied to the A380. - -- [ ] 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/docs/FILE_LIST.md b/docs/FILE_LIST.md new file mode 100644 index 000000000..4ca9d9af7 --- /dev/null +++ b/docs/FILE_LIST.md @@ -0,0 +1,361 @@ +- [X] [FlyByWire Documentation TODOs](TODO_README.md) + - [X] [FlyByWire Aircraft Overview](aircraft/index.md) + - [X] [FlyByWire A32NX Overview](aircraft/a32nx/index.md) + - [X] [A32NX Flight Deck API](aircraft/a32nx/a32nx-api/a32nx-flightdeck-api.md) + - [X] [Common Hardware Controllers and Setup](aircraft/a32nx/a32nx-api/hardware.md) + - [X] [FlyByWire A32NX API](aircraft/a32nx/a32nx-api/index.md) + - [X] [A32NX Developer API](aircraft/a32nx/a32nx-api/lvars-events.md) + - [X] [Audio Configuration](aircraft/a32nx/feature-guides/audio.md) + - [X] [Custom Autopilot / Fly-By-Wire](aircraft/a32nx/feature-guides/autopilot-fbw.md) + - [X] [Custom Camera Views](aircraft/a32nx/feature-guides/camera-views.md) + - [X] [Custom Flight Management System](aircraft/a32nx/feature-guides/cFMS.md) + - [X] [Custom Air Conditioning System](aircraft/a32nx/feature-guides/custom-air-conditioning.md) + - [X] [Custom Hydraulics](aircraft/a32nx/feature-guides/custom-hydraulics.md) + - [X] [Flight Planning](aircraft/a32nx/feature-guides/flight-planning.md) + - [X] [Free Text](aircraft/a32nx/feature-guides/freetext.md) + - [X] [Hoppie ACARS](aircraft/a32nx/feature-guides/hoppie.md) + - [X] [A32NX Feature Guides](aircraft/a32nx/feature-guides/index.md) + - [X] [Fuel and Weight](aircraft/a32nx/feature-guides/loading-fuel-weight.md) + - [X] [MCDU Keyboard](aircraft/a32nx/feature-guides/mcdu-keyboard.md) + - [X] [Nose Wheel and Tiller Operation](aircraft/a32nx/feature-guides/nw-tiller.md) + - [X] [SimBrief and Navigraph Integration](aircraft/a32nx/feature-guides/simbrief.md) + - [X] [Wheel Chocks and GSE Safety Cones](aircraft/a32nx/feature-guides/wheel-chocks-cones.md) + - [X] [Fuel Synchronization](aircraft/a32nx/feature-guides/gsxintegration/fuel.md) + - [X] [GSX Integration](aircraft/a32nx/feature-guides/gsxintegration/index.md) + - [X] [Payload Synchronization](aircraft/a32nx/feature-guides/gsxintegration/payload.md) + - [X] [Profile](aircraft/a32nx/feature-guides/gsxintegration/profile.md) + - [X] [FlyByWire A380X Overview](aircraft/a380x/index.md) + - [X] [INOP System](aircraft/a380x/inop.md) + - [X] [Flight Planning](aircraft/a380x/feature-guides/flight-planning.md) + - [X] [Overview](aircraft/a380x/feature-guides/index.md) + - [X] [Fuel and Weight](aircraft/a380x/feature-guides/loading-fuel-weight.md) + - [X] [SimBrief and Navigraph Integration](aircraft/a380x/feature-guides/simbrief.md) + - [X] [Common Features Documentation](aircraft/common/index.md) + - [X] [flyPad Navigation & Charts](aircraft/common/flypados3/charts.md) + - [X] [Interactive Checklists](aircraft/common/flypados3/checklists.md) + - [X] [flyPad Dashboard](aircraft/common/flypados3/dashboard.md) + - [X] [flyPad Dispatch](aircraft/common/flypados3/dispatch.md) + - [X] [flyPad Failures](aircraft/common/flypados3/failures.md) + - [X] [flyPad Ground](aircraft/common/flypados3/ground.md) + - [X] [flyPadOS 3 EFB](aircraft/common/flypados3/index.md) + - [X] [flyPad Online ATC](aircraft/common/flypados3/online-atc.md) + - [X] [flyPad Performance](aircraft/common/flypados3/performance.md) + - [X] [Interior Lighting and Aircraft Presets](aircraft/common/flypados3/presets.md) + - [X] [flyPad Settings](aircraft/common/flypados3/settings.md) + - [X] [Throttle Calibration](aircraft/common/flypados3/throttle-calibration.md) + - [X] [Versions and Features](aircraft/install/fbw-versions.md) + - [X] [Installation Guide](aircraft/install/installation.md) + - [X] [Liveries Guide](aircraft/install/liveries.md) + - [X] [Recommended Settings](aircraft/install/settings.md) + - [X] [Experimental Version](aircraft/support/exp.md) + - [X] [Support Guide](aircraft/support/index.md) + - [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] [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] [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] [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] [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) + - [X] [Data Management](pilots-corner/a32nx/a32nx-advanced-guides/data-management.md) + - [X] [Ice and Rain Protection](pilots-corner/a32nx/a32nx-advanced-guides/ice-rain-protection.md) + - [X] [Overview](pilots-corner/a32nx/a32nx-advanced-guides/overview.md) + - [X] [Rejected Takeoff in the A320](pilots-corner/a32nx/a32nx-advanced-guides/rejected-take-off.md) + - [X] [ASU Engine Start](pilots-corner/a32nx/a32nx-advanced-guides/engines/asu-start.md) + - [X] [Crossbleed Engine Start](pilots-corner/a32nx/a32nx-advanced-guides/engines/crossbleed-start.md) + - [X] [Approaches](pilots-corner/a32nx/a32nx-advanced-guides/flight-guidance/approaches.md) + - [X] [Autoland](pilots-corner/a32nx/a32nx-advanced-guides/flight-guidance/autoland.md) + - [X] [Autopilot](pilots-corner/a32nx/a32nx-advanced-guides/flight-guidance/autopilot.md) + - [X] [Lateral Guidance](pilots-corner/a32nx/a32nx-advanced-guides/flight-guidance/lnav.md) + - [X] [Flight Guidance in the A320](pilots-corner/a32nx/a32nx-advanced-guides/flight-guidance/overview.md) + - [X] [Traffic Alert and Collision Avoidance System](pilots-corner/a32nx/a32nx-advanced-guides/flight-guidance/tcas.md) + - [X] [Example Managed Flight](pilots-corner/a32nx/a32nx-advanced-guides/flight-guidance/vertical-guidance/example.md) + - [X] [Managed Vertical Modes](pilots-corner/a32nx/a32nx-advanced-guides/flight-guidance/vertical-guidance/managed-modes.md) + - [X] [Vertical Guidance Symbols](pilots-corner/a32nx/a32nx-advanced-guides/flight-guidance/vertical-guidance/nd-symbols.md) + - [X] [Vertical Guidance](pilots-corner/a32nx/a32nx-advanced-guides/flight-guidance/vertical-guidance/overview.md) + - [X] [Primary Flight Display Indications for Vertical Guidance](pilots-corner/a32nx/a32nx-advanced-guides/flight-guidance/vertical-guidance/pfd-indications.md) + - [X] [Selected Vertical Modes](pilots-corner/a32nx/a32nx-advanced-guides/flight-guidance/vertical-guidance/selected-modes.md) + - [X] [Speed/Mach Control](pilots-corner/a32nx/a32nx-advanced-guides/flight-guidance/vertical-guidance/speed-control.md) + - [X] [Direct](pilots-corner/a32nx/a32nx-advanced-guides/flight-planning/direct.md) + - [X] [Discontinuities](pilots-corner/a32nx/a32nx-advanced-guides/flight-planning/disco.md) + - [X] [Fix Info](pilots-corner/a32nx/a32nx-advanced-guides/flight-planning/fixinfo.md) + - [X] [Flight Planning using the MCDU](pilots-corner/a32nx/a32nx-advanced-guides/flight-planning/fplan.md) + - [X] [Holds](pilots-corner/a32nx/a32nx-advanced-guides/flight-planning/holds.md) + - [X] [Leg Types](pilots-corner/a32nx/a32nx-advanced-guides/flight-planning/leg-types.md) + - [X] [Offset](pilots-corner/a32nx/a32nx-advanced-guides/flight-planning/offset.md) + - [X] [Flight Planning Using the MCDU](pilots-corner/a32nx/a32nx-advanced-guides/flight-planning/overview.md) + - [X] [Calculating Takeoff Performance](pilots-corner/a32nx/a32nx-advanced-guides/flight-planning/takeoff-perf-calc.md) + - [X] [Abnormal Laws in the A320](pilots-corner/a32nx/a32nx-advanced-guides/protections/abnormallaw.md) + - [X] [Alpha Floor and TOGA LK](pilots-corner/a32nx/a32nx-advanced-guides/protections/afloor.md) + - [X] [Normal Law Protections in the A320](pilots-corner/a32nx/a32nx-advanced-guides/protections/overview.md) + - [X] [After Landing and Taxi to Gate](pilots-corner/a32nx/a32nx-beginner-guide/after-landing.md) + - [X] [Descent Planning and Descent](pilots-corner/a32nx/a32nx-beginner-guide/descent.md) + - [X] [Engine Start and Taxi](pilots-corner/a32nx/a32nx-beginner-guide/engine-start-taxi.md) + - [X] [Approach and ILS Landing](pilots-corner/a32nx/a32nx-beginner-guide/landing.md) + - [X] [Overview](pilots-corner/a32nx/a32nx-beginner-guide/overview.md) + - [X] [Powering Down](pilots-corner/a32nx/a32nx-beginner-guide/powering-down.md) + - [X] [Preflight](pilots-corner/a32nx/a32nx-beginner-guide/preflight.md) + - [X] [Preparing the MCDU](pilots-corner/a32nx/a32nx-beginner-guide/preparing-mcdu.md) + - [X] [Starting the Aircraft](pilots-corner/a32nx/a32nx-beginner-guide/starting-the-aircraft.md) + - [X] [Takeoff, Climb and Cruise](pilots-corner/a32nx/a32nx-beginner-guide/takeoff-climb-cruise.md) + - [X] [A320neo Pilot Briefing](pilots-corner/a32nx/a32nx-briefing/index.md) + - [X] [Aircraft Limitations](pilots-corner/a32nx/a32nx-briefing/limitations.md) + - [X] [ECAM Engine and Warning Display](pilots-corner/a32nx/a32nx-briefing/ecam/ecam-e-wd.md) + - [X] [ECAM Overview](pilots-corner/a32nx/a32nx-briefing/ecam/index.md) + - [X] [ECAM CRUISE page](pilots-corner/a32nx/a32nx-briefing/ecam/sd/cruise.md) + - [X] [ECAM DOOR page](pilots-corner/a32nx/a32nx-briefing/ecam/sd/door.md) + - [X] [ECAM ENG page](pilots-corner/a32nx/a32nx-briefing/ecam/sd/eng.md) + - [X] [ECAM FUEL page](pilots-corner/a32nx/a32nx-briefing/ecam/sd/fuel.md) + - [X] [ECAM Systems Display](pilots-corner/a32nx/a32nx-briefing/ecam/sd/index.md) + - [X] [ECAM STS page](pilots-corner/a32nx/a32nx-briefing/ecam/sd/sts.md) + - [X] [ECAM WHEEL page](pilots-corner/a32nx/a32nx-briefing/ecam/sd/wheel.md) + - [X] [Flight Deck Overview](pilots-corner/a32nx/a32nx-briefing/flight-deck/index.md) + - [X] [Accumulator Pressure Indication](pilots-corner/a32nx/a32nx-briefing/flight-deck/front/accu.md) + - [X] [Autobrake and Gear Indications](pilots-corner/a32nx/a32nx-briefing/flight-deck/front/autobrake-gear.md) + - [X] [Clock](pilots-corner/a32nx/a32nx-briefing/flight-deck/front/clock.md) + - [X] [Datalink Ctl and Display Unit](pilots-corner/a32nx/a32nx-briefing/flight-deck/front/dcdu.md) + - [X] [Instrument Lighting Control Panel](pilots-corner/a32nx/a32nx-briefing/flight-deck/front/ilcp.md) + - [X] [Integrated Standby Instrument System](pilots-corner/a32nx/a32nx-briefing/flight-deck/front/isis.md) + - [X] [System Display (Lower ECAM)](pilots-corner/a32nx/a32nx-briefing/flight-deck/front/lower-ecam.md) + - [X] [Navigation Display (ND)](pilots-corner/a32nx/a32nx-briefing/flight-deck/front/nd.md) + - [X] [Primary Flight Display (PFD)](pilots-corner/a32nx/a32nx-briefing/flight-deck/front/pfd.md) + - [X] [Engine and Warning Display (Upper ECAM)](pilots-corner/a32nx/a32nx-briefing/flight-deck/front/upper-ecam.md) + - [X] [EFIS Control Panel](pilots-corner/a32nx/a32nx-briefing/flight-deck/glareshield/efis_control.md) + - [X] [Flight Control Unit](pilots-corner/a32nx/a32nx-briefing/flight-deck/glareshield/fcu.md) + - [X] [Instrument Panel Lighting Knobs](pilots-corner/a32nx/a32nx-briefing/flight-deck/glareshield/light-knobs.md) + - [X] [Warning Panel](pilots-corner/a32nx/a32nx-briefing/flight-deck/glareshield/warning.md) + - [X] [3rd Audio Control Panel](pilots-corner/a32nx/a32nx-briefing/flight-deck/ovhd/3rd-acp.md) + - [X] [Air Condition Control Panel](pilots-corner/a32nx/a32nx-briefing/flight-deck/ovhd/ac.md) + - [X] [ADIRS Panel](pilots-corner/a32nx/a32nx-briefing/flight-deck/ovhd/adirs.md) + - [X] [Anti Ice Panel](pilots-corner/a32nx/a32nx-briefing/flight-deck/ovhd/anti-ice.md) + - [X] [Auxiliary Power Unit](pilots-corner/a32nx/a32nx-briefing/flight-deck/ovhd/apu.md) + - [X] [Cabin Pressurization](pilots-corner/a32nx/a32nx-briefing/flight-deck/ovhd/cab-press.md) + - [X] [Calls Panel](pilots-corner/a32nx/a32nx-briefing/flight-deck/ovhd/calls.md) + - [X] [Cargo Smoke Panel](pilots-corner/a32nx/a32nx-briefing/flight-deck/ovhd/cargo-smoke.md) + - [X] [Cargo Vent Panel](pilots-corner/a32nx/a32nx-briefing/flight-deck/ovhd/cargo-vent.md) + - [X] [Electrical System Control Panel](pilots-corner/a32nx/a32nx-briefing/flight-deck/ovhd/elec.md) + - [X] [Emergency Electric Power Panel](pilots-corner/a32nx/a32nx-briefing/flight-deck/ovhd/emergency-electric.md) + - [X] [Engine Manual Start and N1 Mode Panel](pilots-corner/a32nx/a32nx-briefing/flight-deck/ovhd/eng-man.md) + - [X] [Evacuation Panel](pilots-corner/a32nx/a32nx-briefing/flight-deck/ovhd/evacuation.md) + - [X] [Exterior Lighting](pilots-corner/a32nx/a32nx-briefing/flight-deck/ovhd/ext-lt.md) + - [X] [Fire Control Panel](pilots-corner/a32nx/a32nx-briefing/flight-deck/ovhd/fire.md) + - [X] [Flight Control Panels](pilots-corner/a32nx/a32nx-briefing/flight-deck/ovhd/flight-control-computer.md) + - [X] [Fuel Control Panel](pilots-corner/a32nx/a32nx-briefing/flight-deck/ovhd/fuel.md) + - [X] [Ground Proximity Warning Panel](pilots-corner/a32nx/a32nx-briefing/flight-deck/ovhd/gpws.md) + - [X] [Hydraulics Control Panel](pilots-corner/a32nx/a32nx-briefing/flight-deck/ovhd/hyd.md) + - [X] [Internal Lights Panel](pilots-corner/a32nx/a32nx-briefing/flight-deck/ovhd/int-lt.md) + - [X] [Oxygen Panel](pilots-corner/a32nx/a32nx-briefing/flight-deck/ovhd/oxygen.md) + - [X] [PA and Cockpit Video](pilots-corner/a32nx/a32nx-briefing/flight-deck/ovhd/pa-cockpit-video.md) + - [X] [Signs Panel](pilots-corner/a32nx/a32nx-briefing/flight-deck/ovhd/signs.md) + - [X] [Ventilation Panel](pilots-corner/a32nx/a32nx-briefing/flight-deck/ovhd/vent.md) + - [X] [Voice Recorder Panel](pilots-corner/a32nx/a32nx-briefing/flight-deck/ovhd/voice-recorder.md) + - [X] [Wiper Panels](pilots-corner/a32nx/a32nx-briefing/flight-deck/ovhd/wipers.md) + - [X] [Circuit Breaker Panel](pilots-corner/a32nx/a32nx-briefing/flight-deck/ovhd-aft/circuit.md) + - [X] [Cockpit Door Panel](pilots-corner/a32nx/a32nx-briefing/flight-deck/ovhd-aft/cockpit-door.md) + - [X] [Emergency Locator Transmitters Panel](pilots-corner/a32nx/a32nx-briefing/flight-deck/ovhd-aft/elt.md) + - [X] [FMS Load Panel](pilots-corner/a32nx/a32nx-briefing/flight-deck/ovhd-aft/fms-load.md) + - [X] [Maintenance Panel](pilots-corner/a32nx/a32nx-briefing/flight-deck/ovhd-aft/maintenance.md) + - [X] [Pedestal Light and Audio 3 Switch](pilots-corner/a32nx/a32nx-briefing/flight-deck/ovhd-aft/pedestal-light.md) + - [X] [Reading Lights Jump Seats](pilots-corner/a32nx/a32nx-briefing/flight-deck/ovhd-aft/reading-light.md) + - [X] [ATC TCAS Panel](pilots-corner/a32nx/a32nx-briefing/flight-deck/pedestal/atc-tcas.md) + - [X] [Cockpit Door Panel](pilots-corner/a32nx/a32nx-briefing/flight-deck/pedestal/cockpit-door.md) + - [X] [Flightstick and Tiller](pilots-corner/a32nx/a32nx-briefing/flight-deck/pedestal/console.md) + - [X] [ECAM Control Panel](pilots-corner/a32nx/a32nx-briefing/flight-deck/pedestal/ecam-control.md) + - [X] [Engine Panel](pilots-corner/a32nx/a32nx-briefing/flight-deck/pedestal/engine.md) + - [X] [Flaps](pilots-corner/a32nx/a32nx-briefing/flight-deck/pedestal/flaps.md) + - [X] [Emergency Gravity Gear Extension](pilots-corner/a32nx/a32nx-briefing/flight-deck/pedestal/gravity-gear-ext.md) + - [X] [Lighting Pedestal, AIDS, DFDR First Officer Side](pilots-corner/a32nx/a32nx-briefing/flight-deck/pedestal/lighting-aids-dfdr.md) + - [X] [Lighting Pedestal Captain Side](pilots-corner/a32nx/a32nx-briefing/flight-deck/pedestal/lighting-capt.md) + - [X] [Multipurpose Control and Display Unit](pilots-corner/a32nx/a32nx-briefing/flight-deck/pedestal/mcdu.md) + - [X] [Parking Brake Panel](pilots-corner/a32nx/a32nx-briefing/flight-deck/pedestal/parking-brake.md) + - [X] [Printer Panel](pilots-corner/a32nx/a32nx-briefing/flight-deck/pedestal/printer.md) + - [X] [WX Radar Panel](pilots-corner/a32nx/a32nx-briefing/flight-deck/pedestal/radar.md) + - [X] [Radio Management and Audio Control Panel](pilots-corner/a32nx/a32nx-briefing/flight-deck/pedestal/rmp.md) + - [X] [Rudder Trim](pilots-corner/a32nx/a32nx-briefing/flight-deck/pedestal/rudder-trim.md) + - [X] [Speed Brake](pilots-corner/a32nx/a32nx-briefing/flight-deck/pedestal/speedbrake.md) + - [X] [Switching Panel](pilots-corner/a32nx/a32nx-briefing/flight-deck/pedestal/switching.md) + - [X] [Thrust Lever and Pitch Trim](pilots-corner/a32nx/a32nx-briefing/flight-deck/pedestal/thrust-pitch-trim.md) + - [X] [ATC COMM: ATC Communication Applications Page](pilots-corner/a32nx/a32nx-briefing/mcdu/atc-comm.md) + - [X] [DATA: Data Index Page](pilots-corner/a32nx/a32nx-briefing/mcdu/data.md) + - [X] [DIR: Direct To page](pilots-corner/a32nx/a32nx-briefing/mcdu/dir.md) + - [X] [F-PLN: Flight Plan Page](pilots-corner/a32nx/a32nx-briefing/mcdu/f-pln.md) + - [X] [FUEL PRED: Fuel Prediction Page](pilots-corner/a32nx/a32nx-briefing/mcdu/fuel-pred.md) + - [X] [Multipurpose Control and Display Unit](pilots-corner/a32nx/a32nx-briefing/mcdu/index.md) + - [X] [INIT: Initialization Page](pilots-corner/a32nx/a32nx-briefing/mcdu/init.md) + - [X] [MCDU Interface](pilots-corner/a32nx/a32nx-briefing/mcdu/interface.md) + - [X] [MCDU MENU: MCDU Menu Page](pilots-corner/a32nx/a32nx-briefing/mcdu/mcdu-menu.md) + - [X] [MCDU Messages](pilots-corner/a32nx/a32nx-briefing/mcdu/messages.md) + - [X] [PERF: Performance Page](pilots-corner/a32nx/a32nx-briefing/mcdu/perf.md) + - [X] [PROG: Progress page](pilots-corner/a32nx/a32nx-briefing/mcdu/prog.md) + - [X] [RAD NAV: Radio Navigation Page](pilots-corner/a32nx/a32nx-briefing/mcdu/rad-nav.md) + - [X] [SEC F-PLN: Secondary Flight Plan Page](pilots-corner/a32nx/a32nx-briefing/mcdu/sec-f-plan.md) + - [X] [Altitude Indicator](pilots-corner/a32nx/a32nx-briefing/pfd/altitude-indicator.md) + - [X] [Attitude and Guidance](pilots-corner/a32nx/a32nx-briefing/pfd/artificial-horizon.md) + - [X] [Barometric Reference](pilots-corner/a32nx/a32nx-briefing/pfd/baro-ref.md) + - [X] [Autopilot Status Annunciations](pilots-corner/a32nx/a32nx-briefing/pfd/fifth-column.md) + - [X] [Autothrust Mode Annunciations](pilots-corner/a32nx/a32nx-briefing/pfd/first-column.md) + - [X] [Flags and Messages](pilots-corner/a32nx/a32nx-briefing/pfd/flags-messages.md) + - [X] [Flight Mode Annunciator](pilots-corner/a32nx/a32nx-briefing/pfd/fma.md) + - [X] [Approach Annunciations](pilots-corner/a32nx/a32nx-briefing/pfd/fourth-column.md) + - [X] [Heading Reference Line and Scale](pilots-corner/a32nx/a32nx-briefing/pfd/heading-ref.md) + - [X] [ILS Indications](pilots-corner/a32nx/a32nx-briefing/pfd/ils-indicator.md) + - [X] [Primary Flight Display (PFD)](pilots-corner/a32nx/a32nx-briefing/pfd/index.md) + - [X] [Vertical Mode Annunciations](pilots-corner/a32nx/a32nx-briefing/pfd/second-column.md) + - [X] [Common Mode and Special Message Annunciators](pilots-corner/a32nx/a32nx-briefing/pfd/special-message-annunciators.md) + - [X] [Airspeed](pilots-corner/a32nx/a32nx-briefing/pfd/speedtape.md) + - [X] [Lateral Mode Annunciations](pilots-corner/a32nx/a32nx-briefing/pfd/third-column.md) + - [X] [Vertical Speed Indicator](pilots-corner/a32nx/a32nx-briefing/pfd/vertical-speed.md) + - [X] [Standard Operating Procedures](pilots-corner/a380x/a380x-sop.md) + - [X] [Pilot's Corner A380X Overview](pilots-corner/a380x/index.md) + - [X] [Onboard Airport Navigation System (OANS) & Brake To Vacate (BTV)](pilots-corner/a380x/a380x-advanced-guides/oans-btv.md) + - [X] [Overview](pilots-corner/a380x/a380x-advanced-guides/overview.md) + - [X] [Preflight](pilots-corner/a380x/a380x-beginner-guide/01_preflight.md) + - [X] [Cockpit Preparation](pilots-corner/a380x/a380x-beginner-guide/02_cockpit-preparation.md) + - [X] [Preparing the Flight Management System](pilots-corner/a380x/a380x-beginner-guide/03_preparing-fms.md) + - [X] [Engine Start and Taxi](pilots-corner/a380x/a380x-beginner-guide/04_engine-start-taxi.md) + - [X] [Takeoff, Climb and Cruise](pilots-corner/a380x/a380x-beginner-guide/05_takeoff-climb-cruise.md) + - [X] [Descent Planning and Descent](pilots-corner/a380x/a380x-beginner-guide/06_descent.md) + - [X] [Approach and ILS Landing](pilots-corner/a380x/a380x-beginner-guide/07_landing.md) + - [X] [After Landing and Taxi to Gate](pilots-corner/a380x/a380x-beginner-guide/08_after-landing.md) + - [X] [Powering Down](pilots-corner/a380x/a380x-beginner-guide/09_powering-down.md) + - [X] [Overview](pilots-corner/a380x/a380x-beginner-guide/overview.md) + - [X] [A380 Pilot Briefing](pilots-corner/a380x/a380x-briefing/index.md) + - [X] [Flight Deck Overview](pilots-corner/a380x/a380x-briefing/flight-deck/index.md) + - [X] [TODO List for .md Files in `docs/pilots-corner/a380x/a380x-briefing/flight-deck/`](pilots-corner/a380x/a380x-briefing/flight-deck/todo.md) + - [X] [Auto Flight System (AFS) Control Panel](pilots-corner/a380x/a380x-briefing/flight-deck/glareshield/afs.md) + - [X] [Electronic Flight Instrument System (EFIS) Panel](pilots-corner/a380x/a380x-briefing/flight-deck/glareshield/efis.md) + - [X] [Glareshield Side Panels](pilots-corner/a380x/a380x-briefing/flight-deck/glareshield/glare-side.md) + - [X] [Glareshield Underside](pilots-corner/a380x/a380x-briefing/flight-deck/glareshield/glare-underside.md) + - [X] [Center Right Panel](pilots-corner/a380x/a380x-briefing/flight-deck/main-panel/center-right.md) + - [X] [Display Unit Control Panel](pilots-corner/a380x/a380x-briefing/flight-deck/main-panel/efis-reconf.md) + - [X] [Engine Warning Display (EWD)](pilots-corner/a380x/a380x-briefing/flight-deck/main-panel/ewd.md) + - [X] [Gravity Gear Panel](pilots-corner/a380x/a380x-briefing/flight-deck/main-panel/gravity-gear.md) + - [X] [Integrated Standby Instrument System (ISIS)](pilots-corner/a380x/a380x-briefing/flight-deck/main-panel/isis.md) + - [X] [Multi-Function Display (MFD)](pilots-corner/a380x/a380x-briefing/flight-deck/main-panel/mfd.md) + - [X] [Navigation Display (ND)](pilots-corner/a380x/a380x-briefing/flight-deck/main-panel/nd.md) + - [X] [Onboard Information Terminal (OIT)](pilots-corner/a380x/a380x-briefing/flight-deck/main-panel/oit.md) + - [X] [Primary Flight Display (PFD)](pilots-corner/a380x/a380x-briefing/flight-deck/main-panel/pfd.md) + - [X] [System Display (SD)](pilots-corner/a380x/a380x-briefing/flight-deck/main-panel/sd.md) + - [X] [Switching Panel](pilots-corner/a380x/a380x-briefing/flight-deck/main-panel/switching.md) + - [X] [Table and Keyboard](pilots-corner/a380x/a380x-briefing/flight-deck/main-panel/table-keyboard.md) + - [X] [Compass and Eye Reference](pilots-corner/a380x/a380x-briefing/flight-deck/overviews/compass.md) + - [X] [Lateral Consoles](pilots-corner/a380x/a380x-briefing/flight-deck/overviews/lateral-console.md) + - [X] [Main Instrument Panel and Glareshield](pilots-corner/a380x/a380x-briefing/flight-deck/overviews/main-glare.md) + - [X] [Overhead Panel](pilots-corner/a380x/a380x-briefing/flight-deck/overviews/ovhd.md) + - [X] [Pedestal](pilots-corner/a380x/a380x-briefing/flight-deck/overviews/pedestal.md) + - [X] [Seats](pilots-corner/a380x/a380x-briefing/flight-deck/overviews/seats.md) + - [X] [ADIRS Panel](pilots-corner/a380x/a380x-briefing/flight-deck/ovhd/adirs.md) + - [X] [Air Panel](pilots-corner/a380x/a380x-briefing/flight-deck/ovhd/air.md) + - [X] [Anti Ice Panel](pilots-corner/a380x/a380x-briefing/flight-deck/ovhd/anti-ice.md) + - [X] [APU Fire](pilots-corner/a380x/a380x-briefing/flight-deck/ovhd/apu-fire.md) + - [X] [Auxiliary Power Unit](pilots-corner/a380x/a380x-briefing/flight-deck/ovhd/apu.md) + - [X] [Calls Panel](pilots-corner/a380x/a380x-briefing/flight-deck/ovhd/calls.md) + - [X] [Cargo Air Conditioning Panel](pilots-corner/a380x/a380x-briefing/flight-deck/ovhd/cargo-air.md) + - [X] [Cargo Smoke Panel](pilots-corner/a380x/a380x-briefing/flight-deck/ovhd/cargo-smoke.md) + - [X] [Cockpit Voice Recorder (CVR) Panel](pilots-corner/a380x/a380x-briefing/flight-deck/ovhd/cvr.md) + - [X] [Electrical Panel](pilots-corner/a380x/a380x-briefing/flight-deck/ovhd/elec.md) + - [X] [Emergency Locator Transmitter (ELT) Panel](pilots-corner/a380x/a380x-briefing/flight-deck/ovhd/elt.md) + - [X] [Emergency Electrical Panel](pilots-corner/a380x/a380x-briefing/flight-deck/ovhd/emer-elec.md) + - [X] [Engine Fire Panel](pilots-corner/a380x/a380x-briefing/flight-deck/ovhd/eng-fire.md) + - [X] [Engine Manual Start Panel](pilots-corner/a380x/a380x-briefing/flight-deck/ovhd/eng-man.md) + - [X] [Engine Start Panel](pilots-corner/a380x/a380x-briefing/flight-deck/ovhd/eng-start.md) + - [X] [Entertainment Panel](pilots-corner/a380x/a380x-briefing/flight-deck/ovhd/entertainment.md) + - [X] [Exterior Lights Panel](pilots-corner/a380x/a380x-briefing/flight-deck/ovhd/ext-lt.md) + - [X] [Flight Control System Panel](pilots-corner/a380x/a380x-briefing/flight-deck/ovhd/flt-ctl.md) + - [X] [Fuel Jettison Panel](pilots-corner/a380x/a380x-briefing/flight-deck/ovhd/fuel-jettision.md) + - [X] [Fuel Panel](pilots-corner/a380x/a380x-briefing/flight-deck/ovhd/fuel.md) + - [X] [Hydraulic Panel](pilots-corner/a380x/a380x-briefing/flight-deck/ovhd/hyd.md) + - [X] [Internal Lights Panel](pilots-corner/a380x/a380x-briefing/flight-deck/ovhd/int-lt.md) + - [X] [Maintenance Panel](pilots-corner/a380x/a380x-briefing/flight-deck/ovhd/maintenance.md) + - [X] [Oxygen Panel](pilots-corner/a380x/a380x-briefing/flight-deck/ovhd/oxygen.md) + - [X] [Pressurization Panel](pilots-corner/a380x/a380x-briefing/flight-deck/ovhd/press.md) + - [X] [Recording and Evacuation Panel](pilots-corner/a380x/a380x-briefing/flight-deck/ovhd/rcdr-evac.md) + - [X] [Reading Lights Panels](pilots-corner/a380x/a380x-briefing/flight-deck/ovhd/reading.md) + - [X] [Reset Panels](pilots-corner/a380x/a380x-briefing/flight-deck/ovhd/resets.md) + - [X] [Radio Management Panel (RMP)](pilots-corner/a380x/a380x-briefing/flight-deck/ovhd/rmp.md) + - [X] [Signs Panel](pilots-corner/a380x/a380x-briefing/flight-deck/ovhd/signs.md) + - [X] [Ventilation Panel](pilots-corner/a380x/a380x-briefing/flight-deck/ovhd/vent.md) + - [X] [Wiper Panel](pilots-corner/a380x/a380x-briefing/flight-deck/ovhd/wiper.md) + - [X] [Cockpit Door Panel](pilots-corner/a380x/a380x-briefing/flight-deck/pedestal/cockpit-door.md) + - [X] [Cockpit Lighting Panel](pilots-corner/a380x/a380x-briefing/flight-deck/pedestal/cockpit-lighting.md) + - [X] [ECAM Control Panel (ECP)](pilots-corner/a380x/a380x-briefing/flight-deck/pedestal/ecam-cp.md) + - [X] [Thrust and Thrust Reverser Control Levers](pilots-corner/a380x/a380x-briefing/flight-deck/pedestal/engine-master.md) + - [X] [Flight Data Recording System (FDRS)](pilots-corner/a380x/a380x-briefing/flight-deck/pedestal/fdrs.md) + - [X] [Flaps Lever Panel](pilots-corner/a380x/a380x-briefing/flight-deck/pedestal/flap-lever.md) + - [X] [Keyboard Cursor Control Unit (KCCU)](pilots-corner/a380x/a380x-briefing/flight-deck/pedestal/kccu.md) + - [X] [Parking Brake Panel](pilots-corner/a380x/a380x-briefing/flight-deck/pedestal/parking-brake.md) + - [X] [Printer Panel](pilots-corner/a380x/a380x-briefing/flight-deck/pedestal/printer.md) + - [X] [Radio Management Panel (RMP)](pilots-corner/a380x/a380x-briefing/flight-deck/pedestal/rmp.md) + - [X] [Speed Brake Panel](pilots-corner/a380x/a380x-briefing/flight-deck/pedestal/speed-brake.md) + - [X] [Surveillance Panel](pilots-corner/a380x/a380x-briefing/flight-deck/pedestal/surveillance.md) + - [X] [Thrust and Thrust Reverser Control Levers](pilots-corner/a380x/a380x-briefing/flight-deck/pedestal/throttle.md) + - [X] [Trim Panel](pilots-corner/a380x/a380x-briefing/flight-deck/pedestal/trim-panel.md) + - [X] [Airbus Terms and Abbreviations (Selection)](pilots-corner/airliner/abbreviations.md) + - [X] [Airbus Flight Phases](pilots-corner/airliner/flight-phases.md) + - [X] [Airliner and Aviation Overview](pilots-corner/airliner/index.md) + - [X] [Airport Signage and Markings](pilots-corner/airliner/airliner-flying-guide/airport-signage.md) + - [X] [Understanding Altitude references](pilots-corner/airliner/airliner-flying-guide/altitude-refs.md) + - [X] [Types of Approaches](pilots-corner/airliner/airliner-flying-guide/approaches.md) + - [X] [Navigation](pilots-corner/airliner/airliner-flying-guide/navigation.md) + - [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.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) + - [X] [A32NX Stable Release v0.7.3](release-notes/a32nx/v073.md) + - [X] [A32NX Stable Release v0.7.4](release-notes/a32nx/v074.md) + - [X] [A32NX Stable Release v0.7.5](release-notes/a32nx/v075.md) + - [X] [A32NX Stable Release v0.8.0](release-notes/a32nx/v080.md) + - [X] [A32NX Stable Release v0.8.1](release-notes/a32nx/v081.md) + - [X] [A32NX Stable Release v0.8.2](release-notes/a32nx/v082.md) + - [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] [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) + - [X] [Troubleshooting](tools/simbridge/troubleshooting.md) + - [X] [Configuration](tools/simbridge/install-configure/configuration.md) + - [X] [Installation Guide](tools/simbridge/install-configure/installation.md) + - [X] [Starting SimBridge](tools/simbridge/install-configure/start-simbridge.md) + - [X] [Company Routes](tools/simbridge/simbridge-feature-guides/coroute.md) + - [X] [Local Files](tools/simbridge/simbridge-feature-guides/local-files.md) + - [X] [Terrain Display](tools/simbridge/simbridge-feature-guides/terrain.md) + - [X] [Remote MCDU Display Guide](tools/simbridge/simbridge-feature-guides/remote-displays/remote-mcdu.md) \ No newline at end of file diff --git a/docs/TODO_README.md b/docs/TODO_README.md new file mode 100644 index 000000000..4f291d851 --- /dev/null +++ b/docs/TODO_README.md @@ -0,0 +1,158 @@ +# FlyByWire Documentation TODOs + +This page lists all existing pages and currently planned new pages for the FlyByWire Documentation. + +The fact that a page is listed here as done does not mean that it is perfect. It just means that it is in a state that +is good enough for now but might be improved in the future. + +- [X] [**Homepage**](index.md) + +- [X] [**FlyByWire Aircraft**](aircraft/index.md) + - [X] [FAQ](aircraft/faq.md) + - [X] [Installation](aircraft/install/installation.md) + - [X] [Versions](aircraft/install/installation.md) + - [X] [Settings](aircraft/install/installation.md) + - [X] [Liveries](aircraft/install/installation.md) + - [X] [Support](aircraft/support/index.md) + - [X] [Support Guide](aircraft/support/index.md) + - [X] [Performance Tips](aircraft/support/performance-tips.md) + - [X] [Experimental Version](aircraft/support/exp.md) + - [X] [Reported and Known Issues](aircraft/support/known-issues/index.md) + - [X] [A32NX](aircraft/a32nx/index.md) + - [X] [Overview](aircraft/a32nx/index.md) + - [X] [Feature Guides](aircraft/a32nx/feature-guides/index.md) + - [X] [Custom AP](aircraft/a32nx/feature-guides/autopilot-fbw.md) + - [X] [Custom FMS](aircraft/a32nx/feature-guides/cFMS.md) + - [X] [Custom Hydraulics](aircraft/a32nx/feature-guides/custom-hydraulics.md) + - [X] [Custom Air Conditioning](aircraft/a32nx/feature-guides/custom-air-conditioning.md) + - [X] [Audio Configuration](aircraft/a32nx/feature-guides/audio.md) + - [X] [Custom Camera Views](aircraft/a32nx/feature-guides/camera-views.md) + - [X] [Flight Planning](aircraft/a32nx/feature-guides/flight-planning.md) + - [X] [Free Text](aircraft/a32nx/feature-guides/freetext.md) + - [X] [Hoppie ACARS](aircraft/a32nx/feature-guides/hoppie.md) + - [X] [Fuel and Weight](aircraft/a32nx/feature-guides/loading-fuel-weight.md) + - [X] [MCDU Keyboard](aircraft/a32nx/feature-guides/mcdu-keyboard.md) + - [X] [Nose Wheel and Tiller Operation](aircraft/a32nx/feature-guides/nw-tiller.md) + - [X] [SimBrief and Navigraph Integration](aircraft/a32nx/feature-guides/simbrief.md) + - [X] [Wheel Chocks and GSE Safety Cones](aircraft/a32nx/feature-guides/wheel-chocks-cones.md) + - [X] [GSX Integration](aircraft/a32nx/feature-guides/gsxintegration/index.md) + - [X] [API](aircraft/a32nx/a32nx-api/index.md) + - [X] [Common Hardware](aircraft/a32nx/a32nx-api/hardware.md) + - [X] [FlyByWire A32NX API - A32NX Flight Deck API](aircraft/a32nx/a32nx-api/a32nx-flightdeck-api.md) + - [X] [FlyByWire A32NX LVAR Events](aircraft/a32nx/a32nx-api/lvars-events.md) + - [X] [A380X](aircraft/a380x/index.md) + - [X] [Overview](aircraft/a380x/index.md) + - [X] [Feature Guides](aircraft/a380x/feature-guides/index.md) + - [X] [Flight Planning](aircraft/a380x/feature-guides/flight-planning.md) + - [X] [Fuel and Weight](aircraft/a380x/feature-guides/loading-fuel-weight.md) + - [X] [SimBrief and Navigraph Integration](aircraft/a380x/feature-guides/simbrief.md) + - [ ] API (TODO) + - [ ] Common Features TODO + - [X] [flyPadOS 3 EFB](aircraft/common/flypados3/index.md) + - [ ] TODO: Move from A32NX to Common Features and update to include A380X + +- [X] [**Pilot's Corner**](pilots-corner/index.md) + - [X] [A32NX Corner](pilots-corner/a32nx/index.md) + - [X] [Beginner Guide](pilots-corner/a32nx/a32nx-beginner-guide/overview.md) + - [X] [Chapters...](pilots-corner/a32nx/a32nx-beginner-guide/overview.md) + - [X] [Advanced Guide](pilots-corner/a32nx/a32nx-advanced-guides/overview.md) TODO: Move pages to common section and include A380X + - [X] [Engines](pilots-corner/a32nx/a32nx-advanced-guides/engines/asu-start.md) + - [X] [ASU Engine Start](pilots-corner/a32nx/a32nx-advanced-guides/engines/asu-start.md) + - [X] [Crossbleed Engine Start](pilots-corner/a32nx/a32nx-advanced-guides/engines/crossbleed-start.md) + - [X] [Flight Planning](pilots-corner/a32nx/a32nx-advanced-guides/flight-planning/overview.md) + - [X] [Takeoff Performance](pilots-corner/a32nx/a32nx-advanced-guides/flight-planning/takeoff-perf-calc.md) + - [X] [Fix Info](pilots-corner/a32nx/a32nx-advanced-guides/flight-planning/fixinfo.md) + - [X] [Leg Types](pilots-corner/a32nx/a32nx-advanced-guides/flight-planning/leg-types.md) + - [X] [Discontinuities](pilots-corner/a32nx/a32nx-advanced-guides/flight-planning/disco.md) + - [X] [Direct](pilots-corner/a32nx/a32nx-advanced-guides/flight-planning/direct.md) + - [X] [Holds](pilots-corner/a32nx/a32nx-advanced-guides/flight-planning/holds.md) + - [X] [Flight Guidance](pilots-corner/a32nx/a32nx-advanced-guides/flight-guidance/overview.md) + - [X] [Autoland](pilots-corner/a32nx/a32nx-advanced-guides/flight-guidance/autoland.md) + - [X] [TCAS](pilots-corner/a32nx/a32nx-advanced-guides/flight-guidance/tcas.md) + - [X] [Vertical Guidance](pilots-corner/a32nx/a32nx-advanced-guides/flight-guidance/vertical-guidance/overview.md) + - [X] [Overview](pilots-corner/a32nx/a32nx-advanced-guides/flight-guidance/vertical-guidance/overview.md) + - [X] [Selected Vertical Modes](pilots-corner/a32nx/a32nx-advanced-guides/flight-guidance/vertical-guidance/selected-modes.md) + - [X] [Managed Vertical Modes](pilots-corner/a32nx/a32nx-advanced-guides/flight-guidance/vertical-guidance/managed-modes.md) + - [X] [Speed/Mach Control](pilots-corner/a32nx/a32nx-advanced-guides/flight-guidance/vertical-guidance/speed-control.md) + - [X] [Vertical Guidance Symbols](pilots-corner/a32nx/a32nx-advanced-guides/flight-guidance/vertical-guidance/nd-symbols.md) + - [X] [Primary Flight Display Indications](pilots-corner/a32nx/a32nx-advanced-guides/flight-guidance/vertical-guidance/pfd-indications.md) + - [X] [Example Managed Flight](pilots-corner/a32nx/a32nx-advanced-guides/flight-guidance/vertical-guidance/example.md) + - [X] [Protections](pilots-corner/a32nx/a32nx-advanced-guides/protections/overview.md) + - [X] [Normal Law](pilots-corner/a32nx/a32nx-advanced-guides/protections/overview.md) + - [X] [Abnormal Laws](pilots-corner/a32nx/a32nx-advanced-guides/protections/abnormallaw.md) + - [X] [Alpha Floor and TOGA LK](pilots-corner/a32nx/a32nx-advanced-guides/protections/afloor.md) + - [X] [Data Management](pilots-corner/a32nx/a32nx-advanced-guides/data-management.md) + - [X] [Ice and Rain Protection](pilots-corner/a32nx/a32nx-advanced-guides/ice-rain-protection.md) + - [X] [Rejected Takeoff in the A320](pilots-corner/a32nx/a32nx-advanced-guides/rejected-take-off.md) + - [X] [A320neo Pilot Briefing](pilots-corner/a32nx/a32nx-briefing/index.md) + - [X] [Flight-Deck](pilots-corner/a32nx/a32nx-briefing/index.md) + - [X] [PFD](pilots-corner/a32nx/a32nx-briefing/pfd/index.md) + - [ ] ND TODO + - [X] [ECAM](pilots-corner/a32nx/a32nx-briefing/ecam/index.md) + - [X] [ECAM E/WD](pilots-corner/a32nx/a32nx-briefing/ecam/ecam-e-wd.md) + - [X] [ECAM SD](pilots-corner/a32nx/a32nx-briefing/ecam/sd/index.md) + - [X] [MCDU](pilots-corner/a32nx/a32nx-briefing/mcdu/index.md) + - [ ] RMP TODO + - [X] [Limitations](pilots-corner/a32nx/a32nx-briefing/limitations.md) + - [X] [SOP](pilots-corner/a32nx/a32nx-sop.md) + - [X] [A380X Corner](pilots-corner/a380x/index.md) + - [X] [Beginner Guide](pilots-corner/a380x/a380x-beginner-guide/overview.md) + - [X] [Chapters ...](pilots-corner/a380x/a380x-beginner-guide/overview.md) + - [X] [Advanced Guides](pilots-corner/a380x/a380x-advanced-guides/overview.md) + - [X] [OANS / BTV](pilots-corner/a380x/a380x-advanced-guides/oans-btv.md) + - [X] [A380X Pilot Briefing](pilots-corner/a380x/a380x-briefing/index.md) + - [X] [Flight-Deck](pilots-corner/a380x/a380x-briefing/flight-deck/index.md) + - [ ] PFD TODO + - [ ] ND TODO + - [ ] EWD TODO + - [ ] SD TODO + - [ ] MFD TODO + - [ ] RMP TODO + - [X] [SOP](pilots-corner/a380x/a380x-sop.md) + - [X] [Airliner Corner](pilots-corner/airliner/index.md) + - [ ] Airbus Corner (Airbus Specific Common Guide for A32NX and A380X) TODO + - [ ] TODO: Move from A32NX Advanced Guides to here and update to include A380X + - [ ] Terms and Abbreviations (TODO Needs to be moved here) + - [X] [Airliner Flying Guide](pilots-corner/airliner/airliner-flying-guide/overview.md) + - [X] [Types of Approaches](pilots-corner/airliner/airliner-flying-guide/approaches.md) + - [X] [Navigation](pilots-corner/airliner/airliner-flying-guide/navigation.md) + - [X] [Understanding Altitude references](pilots-corner/airliner/airliner-flying-guide/altitude-refs.md) + - [X] [Reading METARs/TAFs/ATIS](pilots-corner/airliner/airliner-flying-guide/weather.md) + - [X] [Runway Conditions](pilots-corner/airliner/airliner-flying-guide/runway-conditions.md) + - [X] [Airport Signage and Markings](pilots-corner/airliner/airliner-flying-guide/airport-signage.md) + +- [X] [**Development Corner**](dev-corner/index.md) + - [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] [Setup Dev Environment](dev-corner/dev-guide/setup-environment.md) + - [ ] Repository Structure TODO + - [X] [Contribution Guidelines](dev-corner/dev-guide/contribute.md) + - [ ] Best Practices TODO + - [ ] Systems Development TODO + - [ ] Instrument Development TODO + - [ ] flyPad Development TODO + - [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) TODO: Move to Localization Guide + - [X] [Javascript](dev-corner/dev-guide/specific/javascript.md) + - [ ] Localization Guide TODO + - [ ] flyPad TODO + - [ ] locPak for MSFS TODO + - [ ] Documentation Guide TODO + - [ ] Livery Creators Guide TODO + - [ ] Other TODO + - [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) TODO: Move up to Documentation GUIDE + - [X] [Website Project](dev-corner/development-projects/website.md) + - [X] [Discord Bot Project](dev-corner/development-projects/discord-bot.md) + +- [X] [**FlyByWire Tools**](tools/index.md) + - [X] [SimBridge](tools/simbridge/index.md) + - [ ] [Installer](tools/installer/index.md) TODO + +- [X] [**Release Notes**](release-notes/index.md) + - [X] ... + diff --git a/docs/aircraft/support/.pages b/docs/aircraft/support/.pages index 3786ebd49..7f1629fe6 100644 --- a/docs/aircraft/support/.pages +++ b/docs/aircraft/support/.pages @@ -2,6 +2,5 @@ title: Support nav: - Support Guide: index.md - performance-tips.md - - exp.md + #- exp.md - Known Issues: known-issues - - ... diff --git a/docs/pilots-corner/a380x/index.md b/docs/pilots-corner/a380x/index.md index 9cacf8d33..307403154 100644 --- a/docs/pilots-corner/a380x/index.md +++ b/docs/pilots-corner/a380x/index.md @@ -17,23 +17,15 @@ in Microsoft Flight Simulator. ## Quick Links [Beginner Guide](a380x-beginner-guide/overview.md){ .md-button } - -[//]: # (TODO) - +[A380X Pilot Briefing](a380x-briefing/index.md){ .md-button } ## Topics -| Featured List | -|:-----------------------------------------------------| -| [Beginner Guide](./a380x-beginner-guide/overview.md) | -| [A380 Pilot Briefing](./a380x-briefing/index.md) | -| [Standard Operating Procedures](./a380x-sop.md) | +| Featured List | +|:-------------------------------------------------------| +| [Beginner Guide](./a380x-beginner-guide/overview.md) | +| [Advanced Guides](./a380x-advanced-guides/overview.md) | +| [A380 Pilot Briefing](./a380x-briefing/index.md) | +| [Standard Operating Procedures](./a380x-sop.md) | -[//]: # (TODO) - \ No newline at end of file diff --git a/docs/update_filelist.py b/docs/update_filelist.py new file mode 100644 index 000000000..85c2b1c52 --- /dev/null +++ b/docs/update_filelist.py @@ -0,0 +1,76 @@ +import os + +# Global variables for the starting folder path and the output file +STARTING_FOLDER = '.' +OUTPUT_FILE = 'FILE_LIST.md' + +def extract_title(file_path): + with open(file_path, 'r', encoding='utf-8') as file: + for line in file: + if line.startswith('# '): + return line[2:].strip() + return None + +def traverse_directory(directory): + pages = [] + for root, _, files in os.walk(directory): + for file in files: + if file.endswith('.md'): + file_path = os.path.join(root, file) + title = extract_title(file_path) + if title: + pages.append((file_path, title)) + return pages + +def format_output(pages, base_directory): + output = [] + previous_first_level_folder = None + for file_path, title in pages: + relative_path = os.path.relpath(file_path, base_directory) + indent_level = relative_path.count(os.sep) + indent = ' ' * 4 * indent_level + first_level_folder = relative_path.split(os.sep)[0] if indent_level > 0 else None + if first_level_folder and first_level_folder != previous_first_level_folder: + if previous_first_level_folder is not None: + output.append('\n') # Add an empty line after each first-level folder + previous_first_level_folder = first_level_folder + output.append(f"{indent}- [X] [{title}]({relative_path.replace(os.sep, '/')})") + return '\n'.join(output) + +def update_existing_output(existing_content, new_content): + existing_lines = existing_content.split('\n') + new_lines = new_content.split('\n') + + updated_lines = [] + new_lines_dict = {line.strip(): line for line in new_lines} + + for line in existing_lines: + stripped_line = line.strip() + if stripped_line.startswith('- [X]') and stripped_line in new_lines_dict: + updated_lines.append(new_lines_dict.pop(stripped_line)) + else: + updated_lines.append(line) + + for new_line in new_lines_dict.values(): + updated_lines.append(new_line) + + return '\n'.join(updated_lines) + +if __name__ == "__main__": + docs_directory = STARTING_FOLDER + pages = traverse_directory(docs_directory) + formatted_output = format_output(pages, docs_directory) + + output_file_path = os.path.join(docs_directory, OUTPUT_FILE) + + if os.path.exists(output_file_path): + with open(output_file_path, 'r', encoding='utf-8') as output_file: + existing_content = output_file.read() + updated_content = update_existing_output(existing_content, formatted_output) + else: + updated_content = formatted_output + + with open(output_file_path, 'w', encoding='utf-8') as output_file: + output_file.write(updated_content) + + print(f"Output updated in {output_file_path}") \ No newline at end of file