Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

refactor: new structure #961

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
2 changes: 1 addition & 1 deletion TODO_README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,6 @@
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, Support Guide, release notes, common questions, Install Guide, etc.)
- (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. ...
2 changes: 1 addition & 1 deletion WIP/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 }

---

Expand Down
16 changes: 8 additions & 8 deletions archive/exp.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand All @@ -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)

Expand Down Expand Up @@ -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).
2 changes: 1 addition & 1 deletion archive/flypados2/dashboard.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion archive/flypados2/online-atc.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
2 changes: 1 addition & 1 deletion archive/flypados2/performance.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

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">
Expand Down
8 changes: 4 additions & 4 deletions archive/flypados2/settings.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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

Expand Down Expand Up @@ -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

Expand Down
20 changes: 10 additions & 10 deletions archive/web-mcdu.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ The MCDU Web Interface allows you to display and control the MCDU on a browser i
See list of compatible and tested browsers: [Compatible Browsers](#compatible-browsers)

!!! note "MCDU Web Interface"
![Web MCDU Interface](../docs/fbw-a32nx/assets/mcdu-server/web-mcdu-ipad.webp "Web MCDU Interface"){loading=lazy}
![Web MCDU Interface](../docs/aircraft/a32nx/assets/mcdu-server/web-mcdu-ipad.webp "Web MCDU Interface"){loading=lazy}

It also allows you to use your real printer as a cockpit printer for the MCDU.

Expand All @@ -32,9 +32,9 @@ To be able to use the MCDU Web Interface you need to start the web server which

To do this locate the `flybywire-aircraft-a320-neo` folder in your MSFS Community folder. Within this folder you will find a folder called `MCDU SERVER`. Open this folder.

![MCDU Server Folder](../docs/fbw-a32nx/assets/mcdu-server/mcdu-server-folder.png "MCDU Server Folder"){loading=lazy}
![MCDU Server Folder](../docs/aircraft/a32nx/assets/mcdu-server/mcdu-server-folder.png "MCDU Server Folder"){loading=lazy}

![MCDU Server Executable](../docs/fbw-a32nx/assets/mcdu-server/mcdr-server.exe.png "MCDU Server Executable"){loading=lazy}
![MCDU Server Executable](../docs/aircraft/a32nx/assets/mcdu-server/mcdr-server.exe.png "MCDU Server Executable"){loading=lazy}

Double-click on the `server.exe` file to start the MCDU Server.

Expand All @@ -51,7 +51,7 @@ After this the MCDU Server will start and will provide you with links for your l

**You will need to keep this window open and the MCDU Server running to use the MCDU Web Interface**.

![MCDU Server Command Window](../docs/fbw-a32nx/assets/mcdu-server/mcdu-server-cmd-window.png "MCDU Server Command Window"){loading=lazy}
![MCDU Server Command Window](../docs/aircraft/a32nx/assets/mcdu-server/mcdu-server-cmd-window.png "MCDU Server Command Window"){loading=lazy}

### MCDU Server Connection Attempts Timeout

Expand All @@ -61,7 +61,7 @@ Therefore, a timeout mechanism has been built into the MCDU limiting the number

A setting in the fylPad EFB Sim Options page has been introduced to allow users to restart the connection attempts or to turn off the attempts to connect to the MCDU Server completely.

![flyPad EFB Settings Sim Options](../docs/fbw-a32nx/assets/mcdu-server/efb-setting-simoptions.png)
![flyPad EFB Settings Sim Options](../docs/aircraft/a32nx/assets/mcdu-server/efb-setting-simoptions.png)

The three settings are:

Expand Down Expand Up @@ -248,11 +248,11 @@ Options:

To use advanced startup options you can use a Windows Powershell or Windows Command Prompt.

![Windows Command Prompt](../docs/fbw-a32nx/assets/mcdu-server/windows-command-prompt.png "Windows Command Prompt"){loading=lazy}
![Windows Command Prompt](../docs/aircraft/a32nx/assets/mcdu-server/windows-command-prompt.png "Windows Command Prompt"){loading=lazy}

Alternatively you can create a Windows Shortcut for the server.exe file and add the parameters to the target field.

![Windows Shortcut Dialog](../docs/fbw-a32nx/assets/mcdu-server/windows-shortcut-dialog.png "Windows Shortcut Dialog"){loading=lazy}
![Windows Shortcut Dialog](../docs/aircraft/a32nx/assets/mcdu-server/windows-shortcut-dialog.png "Windows Shortcut Dialog"){loading=lazy}


### Network Configuration
Expand All @@ -263,7 +263,7 @@ This is typically the case if both, the PC and the device use the same Internet

To check this you can look at the IP address the MCDU server has listed in its command window.

![MCDU Server Command Window](../docs/fbw-a32nx/assets/mcdu-server/mcdu-server-cmd-window.png "MCDU Server Command Window"){loading=lazy}
![MCDU Server Command Window](../docs/aircraft/a32nx/assets/mcdu-server/mcdu-server-cmd-window.png "MCDU Server Command Window"){loading=lazy}

In the example above the IP address is `192.168.1.19`.

Expand Down Expand Up @@ -377,7 +377,7 @@ Of course now the firewall might need to be opened for this new port.

#### Websocket Port is Occupied

If the port for the MCDU Websocket Server is occupied you need to first change this port in the [flyPad EFB Sim options page](../docs/fbw-a32nx/feature-guides/flypados3/settings.md#sim-options).
If the port for the MCDU Websocket Server is occupied you need to first change this port in the [flyPad EFB Sim options page](../docs/aircraft/a32nx/feature-guides/flypados3/settings.md#sim-options).

You can then start the MCDU server using the new websocket port with this option:

Expand Down Expand Up @@ -440,7 +440,7 @@ Now every time Microsoft Flight Simulator starts it will also start the MCDU Ser

## MCDU Server Architecture

![MCDU Server Architecture](../docs/fbw-a32nx/assets/mcdu-server/mcdu-server-architecture.png "MCDU Server Architecture"){loading=lazy}
![MCDU Server Architecture](../docs/aircraft/a32nx/assets/mcdu-server/mcdu-server-architecture.png "MCDU Server Architecture"){loading=lazy}

The MCDU Server uses a web application running in the browser to send and receive data via the Web Socket protocol from the MCDU.

Expand Down
4 changes: 2 additions & 2 deletions docs/.pages
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
nav:
- Home: index.md
- fbw-a32nx
- aircraft
- pilots-corner
- dev-corner
- simbridge
- tools
- release-notes
8 changes: 8 additions & 0 deletions docs/aircraft/.pages
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
title: FlyByWire Aircraft
nav:
- Overview: index.md
- FAQ: faq.md
- Installation: install
- A32NX: a32nx
- A380X: a380x
- Common: common
5 changes: 5 additions & 0 deletions docs/aircraft/a32nx/.pages
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
title: A32NX
nav:
- Overview: index.md
- Feature Guides: feature-guides
- API and Hardware: a32nx-api
File renamed without changes.
Loading
Loading