Skip to content

Commit

Permalink
Update/fixing dev-corner pages
Browse files Browse the repository at this point in the history
  • Loading branch information
frankkopp committed Nov 13, 2024
1 parent 1e9ff8f commit 1e3a090
Show file tree
Hide file tree
Showing 9 changed files with 140 additions and 95 deletions.
2 changes: 1 addition & 1 deletion docs/TODO_README.md
Original file line number Diff line number Diff line change
Expand Up @@ -133,7 +133,7 @@ is good enough for now but might be improved in the future.
- [ ] Best Practices <span style="color: red;">TODO</span>
- [ ] Systems Development <span style="color: red;">TODO</span>
- [ ] Instrument Development <span style="color: red;">TODO</span>
- [ ] flyPad Development <span style="color: red;">TODO</span>
- [ ] flyPad Development <span style="color: red;">TODO - page exists but needs update</span>
- [X] [Specific](dev-corner/dev-guide/specific/index.md)
- [X] [Overview](dev-corner/dev-guide/specific/index.md)
- [X] [Instruments Build Guide](dev-corner/dev-guide/specific/instruments-build-guide)
Expand Down
3 changes: 2 additions & 1 deletion docs/dev-corner/dev-guide/contribute.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,8 @@ review and accept. Large PRs with a small error will prevent the entire PR from
## Helping others

Please help other contributors to the project wherever you can, as people all start somewhere. If you require assistance
or wish to provide assistance, you can ask/answer questions on the [#dev-support](https://discord.gg/v3jAxJpwZm){target=new} channel on discord.
or wish to provide assistance, you can ask/answer questions on the
[#dev-support](https://discord.gg/v3jAxJpwZm){target=new} channel on discord.

## Finding tasks

Expand Down
5 changes: 0 additions & 5 deletions docs/dev-corner/dev-guide/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,11 +24,6 @@ assurance process.
This documentation describes the FlyByWire Development Process and tools in detail to help you set up your
development environment to be able to efficiently contribute to our projects.

!!! info "Structure"
Currently these sections are specific to the A32NX. It details with the necessary software and tools, downloading and compiling the A32NX successfully, as well as guidelines on how to contribute within the project.

We will adapt our documentation to cover A380X development requirements in the future as well.

## Topics

| Quick Links | Description |
Expand Down
147 changes: 101 additions & 46 deletions docs/dev-corner/dev-guide/qa-process.md

Large diffs are not rendered by default.

48 changes: 18 additions & 30 deletions docs/dev-corner/dev-guide/resources.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,18 +6,18 @@ description: Resources for working with and on the A32NX and A380X code.
# Resources

On this page, you will find all the necessary resources, links, and documentation you might need to work with and on the
A32NX code.
A32NX and A380X code.

## GitHub Repositories

The main GitHub repository for the A32NX aircraft is:
The main GitHub repository for the FlyByWire aircraft is:

**[https://github.com/flybywiresim/aircraft](https://github.com/flybywiresim/aircraft){target=new}**

The Development version of the FlyByWire A32NX is done in the master branch. Whenever something is merged into the
master branch, an automatic build process builds the newest Development version and uploads it to our CDN, so users can
download the latest Development version via the FlyByWire Installer. We have a very strict development, review and QA
process for this version.
The Development versions of the FlyByWire A32NX and A380X are done in the master branch. Whenever something is merged
into the master branch, an automatic build process builds the newest Development version and uploads it to our CDN, so
users can download the latest Development version via the FlyByWire Installer. We have a very strict development, review
and QA process for this version.

The Stable version is a snapshot (in git terms, a [Tag](https://github.com/flybywiresim/aircraft/tags){target=new}) of
the development branch.
Expand All @@ -32,44 +32,32 @@ to supporting developers (in fact, most channels).

[:fontawesome-brands-discord:{: .discord } - **Discord Link**](https://discord.gg/flybywire){target=new}

First get yourself the "programmer" role in
First, get yourself the "programmer" role in
[#roles](https://discord.com/channels/738864299392630914/751780817772216401/816730253543604224){target=new}.

The most general channel for getting help for development is [#dev-support](https://discord.gg/v3jAxJpwZm){target=new}.

There are many other channels for specific systems or subprojects. If you are working on the flyPad EFB for example, the
`#efb` channel would be an important channel for collaborating and support.
There are several other channels for specific systems or subprojects.

## Tech Stack

Our tech stack includes the following:
Below you can find a table summary of the languages and technologies used in the FylByWire aircraft project.

!!! info "Tech Stack / Language Summary"
Below you can find a table summary of the languages and technologies used in the A32NX project.

| Category | Language / Technology |
|:------------------------------|-----------------------------------------------------------|
| General | React |
| flyPadOS | Tailwind CSS, Redux |
| Autopilot / Flight Controls | MATLAB / C++ |
| Systems / Physics Simulations | Rust |
| Displays / Avionics | Typescript / React (deprecated) / MSFS Avionics Framework |
| Category | Language / Technology |
|:---------------------------------------------|-----------------------------------------------------------|
| General | React |
| flyPadOS | Tailwind CSS, Redux |
| Autopilot / Flight Controls / Extra Backends | MATLAB / C++ |
| Systems / Physics Simulations | Rust |
| Displays / Avionics | Typescript / React (deprecated) / MSFS Avionics Framework |

- Systems development for aircraft uses Rust and the `msfs-rs` library.
- Avionics programming is done using JavaScript or TypeScript (depending on the project), with the `React.js` rendering
library.
library or the newer
[MSFS Avionics Framework](https://microsoft.github.io/msfs-avionics-mirror/docs/intro/){target=new}.
- Front-end web or desktop app development uses the same technologies outlined above.
- Server-side development uses `nest.js` for the API and `MySQL` for the database backend.

Knowledge of all items on this list is obviously not necessary, but this can hopefully give you a better insight into
what your skills can fit into.

## Tools

A number of tools make development in Microsoft Flight Simulator easier.

- [WebUI-DevKit](https://github.com/dga711/msfs-webui-devkit){target=new} - In-game development overlay for html-ui
content. Provides fast reload, console output, and more!
- [devtools-backend-refurb](https://github.com/dga711/devtools-backend-refurb){target=new} - Chrome DevTools server
targeting Coherent GT. Gives you DevTools for html-ui content. WARNING: This is still a work in progress, and tends to
be very finicky.
2 changes: 1 addition & 1 deletion docs/dev-corner/dev-guide/specific/.pages
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,6 @@ title: Specific
nav:
- index.md
- instruments-build-guide.md
- flypad-dev-guide.md
#- flypad-dev-guide.md
- flypad-localization.md
- javascript-dev-guide.md
2 changes: 2 additions & 0 deletions docs/dev-corner/dev-guide/specific/flypad-dev-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ search:

# flyPad Development Guide

<h1><span style="color: yellow;">This guide needs to be updated.</span></h1>

## Quick Reloading the flyPad

As the aircraft in your project folder is now connected to your MSFS community folder via the Symlink you created in the previous step, each time you load in to the A32NX on MSFS, any changes you've made since the sim was last opened should be updated.
Expand Down
6 changes: 4 additions & 2 deletions docs/dev-corner/dev-guide/specific/flypad-localization.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
# flyPadOS 3 Localization Process

This page is pulled externally from the FBW Aircraft repository and describes the processes involved with adding features to the EFB and sourcing translations.
This page is pulled externally from the FBW Aircraft repository and describes the processes involved with adding
features to the EFB and sourcing translations.

We have partnered with Localazy, who offer top-notch software localization services, bringing multi-language support to our EFB, enhancing the user experience.
We have partnered with Localazy, who offer top-notch software localization services, bringing multi-language support to
our EFB, enhancing the user experience.

<figure markdown>
[![localazy-mono-logo.svg](../../assets/localazy-mono-logo.svg){ width="300" }](https://localazy.com/term/software-localization?utm_source=flybywiresim.
Expand Down
20 changes: 11 additions & 9 deletions docs/dev-corner/index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Development Corner - Overview
description: The Development Corner is dedicated to providing information about the various FlyByWire projects and how to contribute.
description: The Development Corner is dedicated to providing information about the various FlyByWire projects and how
to contribute.
---

<link rel="stylesheet" href="../../../stylesheets/toc-tables.css">
Expand All @@ -9,18 +10,19 @@ description: The Development Corner is dedicated to providing information about

Welcome to the Development Corner of the FlyByWire Documentation site.

This section of the FlyByWire Documentation is dedicated to the development aspects of the A32NX add-on. It is aimed at developers, contributors, or anyone who would like to start contributing to the project.
This section of the FlyByWire Documentation is dedicated to the development aspects of the A32NX and A380X aircraft. It
is aimed at developers, contributors, or anyone who would like to start contributing to the project.

[:fontawesome-brands-github:{: .github } **GitHub Contributing.md**](https://github.com/flybywiresim/aircraft/blob/master/.github/Contributing.md){ .md-button target=new}

## Quick Links

| Topics |
|:-------------------------------------------------------|
| [Development Guide](dev-guide/index.md) |
| [Livery Creator Guide](livery-creators/index.md) |
| [Documentation Guide](documentation-guide/index) |
| [Other](other) |
| [FlyByWire Projects](flybywire-projects/index.md) |
| Topics |
|:--------------------------------------------------|
| [Development Guide](dev-guide/index.md) |
| [Livery Creator Guide](livery-creators/index.md) |
| [Documentation Guide](documentation-guide/index) |
| [Other](other) |
| [FlyByWire Projects](flybywire-projects/index.md) |

[//]: # (| [Localization Guide]&#40;localization-guide/index.md&#41; |)

0 comments on commit 1e3a090

Please sign in to comment.