From 5a4aacf6478929747b225582870de41916c56bc1 Mon Sep 17 00:00:00 2001 From: Frank Kopp Date: Fri, 1 Nov 2024 13:15:44 +0100 Subject: [PATCH] Clean up TODO and small fixes --- TODO_README.md | 245 ------------------------------ docs/TODO_README.md | 159 +++++++++++++++++++ docs/aircraft/support/.pages | 3 +- docs/pilots-corner/a380x/index.md | 22 +-- 4 files changed, 167 insertions(+), 262 deletions(-) delete mode 100644 TODO_README.md create mode 100644 docs/TODO_README.md 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/TODO_README.md b/docs/TODO_README.md new file mode 100644 index 000000000..3b03787f1 --- /dev/null +++ b/docs/TODO_README.md @@ -0,0 +1,159 @@ +# 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/overview.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/fuel-and-weight.md) + - [X] [SimBrief and Navigraph Integration](aircraft/a380x/feature-guides/simbrief-and-navigraph-integration.md) + - [ ] API (TODO) + - [ ] Common Features TODO + - [X] [flyPadOS 3 EFB](aircraft/common-features/flypados-3-efb.md) + - [ ] TODO: Move from A32NX to Common Features and update to include A380X + +- [X] [**Pilot's Corner**](pilots-corner/index.md) + - [X] [Overview](pilots-corner/overview.md) + - [X] [A32NX Corner](pilots-corner/a32nx-corner/index.md) + - [X] [Beginner Guide](pilots-corner/a32nx-corner/beginner-guide/index.md) + - [X] [Chapters...](pilots-corner/a32nx-corner/beginner-guide/chapters.md) + - [X] [Advanced Guide](pilots-corner/a32nx-corner/advanced-guide/index.md) TODO: Move pages to common section and include A380X + - [X] [Engines](pilots-corner/a32nx-corner/advanced-guide/engines/index.md) + - [X] [ASU Engine Start](pilots-corner/a32nx-corner/advanced-guide/engines/asu-engine-start.md) + - [X] [Crossbleed Engine Start](pilots-corner/a32nx-corner/advanced-guide/engines/crossbleed-engine-start.md) + - [X] [Flight Planning](pilots-corner/a32nx-corner/advanced-guide/flight-planning/index.md) + - [X] [Takeoff Performance](pilots-corner/a32nx-corner/advanced-guide/flight-planning/takeoff-performance.md) + - [X] [Fix Info](pilots-corner/a32nx-corner/advanced-guide/flight-planning/fix-info.md) + - [X] [Leg Types](pilots-corner/a32nx-corner/advanced-guide/flight-planning/leg-types.md) + - [X] [Discontinuities](pilots-corner/a32nx-corner/advanced-guide/flight-planning/discontinuities.md) + - [X] [Direct](pilots-corner/a32nx-corner/advanced-guide/flight-planning/direct.md) + - [X] [Holds](pilots-corner/a32nx-corner/advanced-guide/flight-planning/holds.md) + - [X] [Flight Guidance](pilots-corner/a32nx-corner/advanced-guide/flight-guidance/index.md) + - [X] [Autoland](pilots-corner/a32nx-corner/advanced-guide/flight-guidance/autoland.md) + - [X] [TCAS](pilots-corner/a32nx-corner/advanced-guide/flight-guidance/tcas.md) + - [X] [Vertical Guidance](pilots-corner/a32nx-corner/advanced-guide/flight-guidance/vertical-guidance/index.md) + - [X] [Overview](pilots-corner/a32nx-corner/advanced-guide/flight-guidance/vertical-guidance/overview.md) + - [X] [Selected Vertical Modes](pilots-corner/a32nx-corner/advanced-guide/flight-guidance/vertical-guidance/selected-vertical-modes.md) + - [X] [Managed Vertical Modes](pilots-corner/a32nx-corner/advanced-guide/flight-guidance/vertical-guidance/managed-vertical-modes.md) + - [X] [Speed/Mach Control](pilots-corner/a32nx-corner/advanced-guide/flight-guidance/vertical-guidance/speed-mach-control.md) + - [X] [Vertical Guidance Symbols](pilots-corner/a32nx-corner/advanced-guide/flight-guidance/vertical-guidance/vertical-guidance-symbols.md) + - [X] [Primary Flight Display Indications](pilots-corner/a32nx-corner/advanced-guide/flight-guidance/vertical-guidance/primary-flight-display-indications.md) + - [X] [Example Managed Flight](pilots-corner/a32nx-corner/advanced-guide/flight-guidance/vertical-guidance/example-managed-flight.md) + - [X] [Protections](pilots-corner/a32nx-corner/advanced-guide/protections/index.md) + - [X] [Normal Law](pilots-corner/a32nx-corner/advanced-guide/protections/normal-law.md) + - [X] [Abnormal Laws](pilots-corner/a32nx-corner/advanced-guide/protections/abnormal-laws.md) + - [X] [Alpha Floor and TOGA LK](pilots-corner/a32nx-corner/advanced-guide/protections/alpha-floor-and-toga-lk.md) + - [X] [Data Management](pilots-corner/a32nx-corner/advanced-guide/data-management.md) + - [X] [Ice and Rain Protection](pilots-corner/a32nx-corner/advanced-guide/ice-and-rain-protection.md) + - [X] [Rejected Takeoff in the A320](pilots-corner/a32nx-corner/advanced-guide/rejected-takeoff-in-the-a320.md) + - [X] [A320neo Pilot Briefing](pilots-corner/a32nx-corner/a320neo-pilot-briefing/index.md) + - [X] [Flight-Deck](pilots-corner/a32nx-corner/a320neo-pilot-briefing/flight-deck.md) + - [X] [PFD](pilots-corner/a32nx-corner/a320neo-pilot-briefing/pfd.md) + - [ ] [ND](pilots-corner/a32nx-corner/a320neo-pilot-briefing/nd.md) TODO + - [X] [ECAM](pilots-corner/a32nx-corner/a320neo-pilot-briefing/ecam/index.md) + - [X] [ECAM E/WD](pilots-corner/a32nx-corner/a320neo-pilot-briefing/ecam/ecam-ewd.md) + - [X] [ECAM SD](pilots-corner/a32nx-corner/a320neo-pilot-briefing/ecam/ecam-sd.md) + - [X] [MCDU](pilots-corner/a32nx-corner/a320neo-pilot-briefing/mcdu.md) + - [ ] [RMP](pilots-corner/a32nx-corner/a320neo-pilot-briefing/rmp.md) TODO + - [X] [Limitations](pilots-corner/a32nx-corner/a320neo-pilot-briefing/limitations.md) + - [X] [SOP](pilots-corner/a32nx-corner/sop.md) + - [X] [A380X Corner](pilots-corner/a380x-corner/index.md) + - [X] [Beginner Guide](pilots-corner/a380x-corner/beginner-guide/index.md) + - [X] [Chapters ...](pilots-corner/a380x-corner/beginner-guide/chapters.md) + - [X] [Advanced Guides](pilots-corner/a380x-corner/advanced-guides/index.md) + - [X] [OANS / BTV](pilots-corner/a380x-corner/advanced-guides/oans-btv.md) + - [X] [A380X Pilot Briefing](pilots-corner/a380x-corner/a380x-pilot-briefing/index.md) + - [X] [Flight-Deck](pilots-corner/a380x-corner/a380x-pilot-briefing/flight-deck.md) + - [ ] [PFD](pilots-corner/a380x-corner/a380x-pilot-briefing/pfd.md) TODO + - [ ] [ND](pilots-corner/a380x-corner/a380x-pilot-briefing/nd.md) TODO + - [ ] [EWD](pilots-corner/a380x-corner/a380x-pilot-briefing/ewd.md) TODO + - [ ] [SD](pilots-corner/a380x-corner/a380x-pilot-briefing/sd.md) TODO + - [ ] [MFD](pilots-corner/a380x-corner/a380x-pilot-briefing/mfd.md) TODO + - [ ] [RMP](pilots-corner/a380x-corner/a380x-pilot-briefing/rmp.md) TODO + - [X] [SOP](pilots-corner/a380x-corner/sop.md) + - [X] [Airliner Corner](pilots-corner/airliner-corner/index.md) + - [ ] [Airbus Corner](pilots-corner/airliner-corner/airbus-corner.md) (Airbus Specific Common Guide for A32NX and A380X) TODO + - [ ] TODO: Move from A32NX Advanced Guides to here and update to include A380X + - [X] [Terms and Abbreviations](pilots-corner/airliner-corner/terms-and-abbreviations.md) (TODO Needs to be moved here) + - [X] [Airliner Flying Guide](pilots-corner/airliner-corner/airliner-flying-guide/index.md) + - [X] [Types of Approaches](pilots-corner/airliner-corner/airliner-flying-guide/types-of-approaches.md) + - [X] [Navigation](pilots-corner/airliner-corner/airliner-flying-guide/navigation.md) + - [X] [Understanding Altitude references](pilots-corner/airliner-corner/airliner-flying-guide/understanding-altitude-references.md) + - [X] [Reading METARs/TAFs/ATIS](pilots-corner/airliner-corner/airliner-flying-guide/reading-metars-tafs-atis.md) + - [X] [Runway Conditions](pilots-corner/airliner-corner/airliner-flying-guide/runway-conditions.md) + - [X] [Airport Signage and Markings](pilots-corner/airliner-corner/airliner-flying-guide/airport-signage-and-markings.md) + +- [X] [**Development Corner**](development-corner/index.md) + - [X] [Developer Guide](development-corner/developer-guide/index.md) + - [X] [Overview](development-corner/developer-guide/overview.md) + - [X] [Resources](development-corner/developer-guide/resources.md) + - [X] [Setup Dev Environment](development-corner/developer-guide/setup-dev-environment.md) + - [ ] [Repository Structure](development-corner/developer-guide/repository-structure.md) TODO + - [X] [Contribution Guidelines](development-corner/developer-guide/contribution-guidelines.md) + - [ ] [Best Practices](development-corner/developer-guide/best-practices.md) TODO + - [ ] [Systems Development](development-corner/developer-guide/best-practices/systems-development.md) TODO + - [ ] [Instrument Development](development-corner/developer-guide/best-practices/instrument-development.md) TODO + - [ ] [flyPad Development](development-corner/developer-guide/best-practices/flypad-development.md) TODO + - [X] [Specific](development-corner/developer-guide/specific/index.md) + - [X] [Overview](development-corner/developer-guide/specific/overview.md) + - [X] [Instruments Build Guide](development-corner/developer-guide/specific/instruments-build-guide.md) + - [X] [flyPadOS 3 Localization Process](development-corner/developer-guide/specific/flypados-3-localization-process.md) TODO: Move to Localization Guide + - [X] [Javascript](development-corner/developer-guide/specific/javascript.md) + - [ ] [Localization Guide](development-corner/localization-guide/index.md) TODO + - [ ] [flyPad](development-corner/localization-guide/flypad.md) TODO + - [ ] [locPak for MSFS](development-corner/localization-guide/locpak-for-msfs.md) TODO + - [ ] [Documentation Guide](development-corner/documentation-guide/index.md) TODO + - [ ] [Livery Creators Guide](development-corner/livery-creators-guide/index.md) TODO + - [ ] [Other](development-corner/other/index.md) TODO + - [X] [FlyByWire Projects](development-corner/flybywire-projects/index.md) + - [X] [Overview](development-corner/flybywire-projects/overview.md) + - [X] [Documentation Project](development-corner/flybywire-projects/documentation-project.md) TODO: Move up to Documentation GUIDE + - [X] [Website Project](development-corner/flybywire-projects/website-project.md) + - [X] [Discord Bot Project](development-corner/flybywire-projects/discord-bot-project.md) + +- [X] [**FlyByWire Tools**](flybywire-tools/index.md) + - [X] [SimBridge](flybywire-tools/simbridge.md) + - [ ] [Installer](flybywire-tools/installer.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