Skip to content

Commit 4aa9452

Browse files
pluceValastiri
andauthored
docs: update references to old a32nx repo
* docs: update references to old a32nx repo * Update docs/dev-corner/dev-guide/setup-environment.md Co-authored-by: Val <[email protected]> * Update docs/dev-corner/development-projects/index.md Co-authored-by: Val <[email protected]> * Update docs/dev-corner/dev-guide/specific/flypad-translations.md Co-authored-by: Val <[email protected]> --------- Co-authored-by: Val <[email protected]>
1 parent f935824 commit 4aa9452

21 files changed

+51
-51
lines changed

README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ Note: Please be aware that sub-directories are present in the parent directories
2323

2424
## A32NX Project
2525

26-
[FlyByWire Simulations A32NX Repo](https://github.com/flybywiresim/a32nx)
26+
[FlyByWire Simulations Aircraft Repo](https://github.com/flybywiresim/aircraft)
2727

2828
[https://flybywiresim.com/](https://flybywiresim.com/)
2929

archive/exp.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Currently, experimental is geared toward testing the initial version of VNAV wit
1919

2020
We are testing the new FWS (Flight Warning System) which replaces the previous provisional system.
2121
See technical details in the respective
22-
[GitHub Pull Request #4872](https://github.com/flybywiresim/a32nx/pull/4872){target=new}.
22+
[GitHub Pull Request #4872](https://github.com/flybywiresim/aircraft/pull/4872){target=new}.
2323

2424
![fws-init-ecam](../docs/pilots-corner/assets/beginner-guide/starting-aircraft/fws-init-ecam.png){loading=lazy width=50%}
2525

docs/dev-corner/dev-guide/contribute.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -18,13 +18,13 @@ As contributors and maintainers of this project, we pledge to respect all people
1818

1919
Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, issues and other contributions that are not aligned to this Code of Conduct.
2020

21-
Make sure to read our [Code of Conduct](https://github.com/flybywiresim/a32nx/blob/master/CODE_OF_CONDUCT.md)
21+
Make sure to read our [Code of Conduct](https://github.com/flybywiresim/aircraft/blob/master/CODE_OF_CONDUCT.md)
2222

2323
## Pull Requests
2424

2525
We welcome pull requests with fixes and improvements to the project.
2626

27-
If you wish to add a new feature or you spot a bug that you wish to fix, **please open an issue for it first** on the [A32NX issue tracker](https://github.com/flybywiresim/a32nx/issues).
27+
If you wish to add a new feature or you spot a bug that you wish to fix, **please open an issue for it first** on the [FBW Aircraft issue tracker](https://github.com/flybywiresim/aircraft/issues).
2828

2929
The work-flow for submitting a new pull request is designed to be simple, but also to ensure consistency from **all** contributors:
3030

@@ -49,7 +49,7 @@ Please help other contributors to the project wherever you can, as people all st
4949

5050
## Finding tasks
5151

52-
The best place to look for possible things where you could contribute is the A32NX GitHub repository's [Issues List](https://github.com/flybywiresim/a32nx/issues){target=new}.
52+
The best place to look for possible things where you could contribute is the FBW Aircraft GitHub repository's [Issues List](https://github.com/flybywiresim/aircraft/issues){target=new}.
5353
There you can find open bug reports or feature requests from users or other developers.
5454

5555
## Issues

docs/dev-corner/dev-guide/resources.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,13 @@ On this page, you will find all the necessary resources, links, and documentatio
66

77
The main GitHub repository for the A32NX aircraft is:
88

9-
**[https://github.com/flybywiresim/a32nx](https://github.com/flybywiresim/a32nx){target=new}**
9+
**[https://github.com/flybywiresim/aircraft](https://github.com/flybywiresim/aircraft){target=new}**
1010

1111
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
1212
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
1313
QA process for for this version.
1414

15-
The Stable version is a snapshot (in git terms, a [Tag](https://github.com/flybywiresim/a32nx/tags){target=new}) of the development branch.
15+
The Stable version is a snapshot (in git terms, a [Tag](https://github.com/flybywiresim/aircraft/tags){target=new}) of the development branch.
1616

1717
The FlyByWire project has other repositories for subprojects like api, msfs-rs, installer, website, docs, etc. Find them [here](https://github.com/orgs/flybywiresim/repositories){target=new}.
1818

docs/dev-corner/dev-guide/setup-environment.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -26,29 +26,29 @@ Most of our team works with either Visual Studio Code or IntelliJ IDEA-based IDE
2626

2727
## Getting the source code
2828

29-
To work on the A32NX project, you need to create a fork ( [GitHub fork](https://docs.github.com/en/get-started/quickstart/fork-a-repo){target=new)}) of the [a32nx repository](https://github.com/flybywiresim/a32nx).
29+
To work on the A32NX project, you need to create a fork ( [GitHub fork](https://docs.github.com/en/get-started/quickstart/fork-a-repo){target=new)}) of the [aircraft repository](https://github.com/flybywiresim/aircraft).
3030

3131
Clone this fork to your local environment. You can use the command line git or a UI-based git to do this. On the command line, go to your projects folder and clone it into that folder.
3232

3333
```
34-
git clone https://github.com/flybywiresim/a32nx.git
34+
git clone https://github.com/flybywiresim/aircraft.git
3535
```
3636

37-
You now have a copy of the a32nx repository on your local machine to review and change the source code.
37+
You now have a copy of the aircraft repository on your local machine to review and change the source code. The subfolder `./fbw-a320nx` contains the A32NX source code.
3838

3939
## Compiling the source
4040

4141
To compile the source code into a package you can install into the Microsoft Flight Simulator Community folder, we have prepared a few scripts you need to run, which in turn use the Docker container mentioned above to compile the aircraft add-on.
4242

4343

4444
```powershell title="PowerShell or Cmd Prompt"
45-
cd a32nx
45+
cd aircraft
4646
.\scripts\dev-env\run.cmd ./scripts/setup.sh
4747
.\scripts\dev-env\run.cmd ./scripts/build.sh
4848
```
4949

5050
```bash title="git bash or other *nix shells on Windows"
51-
cd a32nx
51+
cd aircraft
5252
./scripts/dev-env/run.cmd ./scripts/setup.sh
5353
./scripts/dev-env/run.cmd ./scripts/build.sh
5454
```
@@ -85,7 +85,7 @@ mklink /J [MSFS Community folder\flybywire-aircraft-a320-neo] [Project folder pa
8585

8686
Example:
8787
```
88-
mklink /J C:\Users\USERNAME\AppData\Local\Packages\Microsoft.FlightSimulator_8wekyb3d8bbwe\Community\flybywire-aircraft-a320-neo C:\Users\USERNAME\IdeaProjects\a32nx\fbw-a32nx\out\flybywire-aircraft-a320-neo
88+
mklink /J C:\Users\USERNAME\AppData\Local\Packages\Microsoft.FlightSimulator_8wekyb3d8bbwe\Community\flybywire-aircraft-a320-neo C:\Users\USERNAME\IdeaProjects\aircraft\fbw-a32nx\out\flybywire-aircraft-a320-neo
8989
```
9090

9191
If this works, you'll receive the response:

docs/dev-corner/dev-guide/specific/flypad-dev.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ VCockpit16 - EFB_TEMPLATE [coui://html_UI/Pages/VCockpit/Core/VCockpit.html]
3333
Now you're set up with your own fork, which you can reload instantly and test in MSFS, you're ready to get started making changes. When getting started, it's a good idea to spend some time looking around the project and wrapping your head around the structure.
3434

3535
- You'll find the main EFB content under ` src/instruments/src/EFB ` of your GitHub fork, try making small changes at first to test, such as changing the color of an icon, or changing a few words to make sure the reloading is working.
36-
- Take a look at previous commits made to the flyPad on the [A32NX GitHub Repository](https://github.com/flybywiresim/a32nx/commits/master){target=new} and see what changes were made to get the desired result.
36+
- Take a look at previous commits made to the flyPad on the [FBW Aircraft GitHub Repository](https://github.com/flybywiresim/aircraft/commits/master){target=new} and see what changes were made to get the desired result.
3737

3838
!!!info "Top tip!"
3939
When working on your project, make sure to reload the flyPad and test regularly to catch issues as soon as they happen.

docs/dev-corner/dev-guide/specific/flypad-translations.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# flyPadOS 3 Localization Process
22

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

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

@@ -11,4 +11,4 @@ com&utm_medium=sponsored-referral&utm_campaign=partnerships&utm_content=footer-l
1111

1212
---
1313

14-
{{ external_markdown('https://raw.githubusercontent.com/flybywiresim/a32nx/master/fbw-a32nx/src/localization/README.md', '') }}
14+
{{ external_markdown('https://raw.githubusercontent.com/flybywiresim/aircraft/master/fbw-a32nx/src/localization/README.md', '') }}

docs/dev-corner/development-projects/ace.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ The MSFS CoherentGT engine API is emulated in `ace`, including the `call`, `trig
3535
3. Run ace with `npm start`
3636
4. After running the program, select New Project and choose the locations of all your folders. (see [below] (#example-config))
3737
5. Add a Web Instrument to localhost:9696 (right-click on the project canvas)
38-
6. Open a new terminal and go to your a32nx clone folder and run: `npm run serve:efb`
38+
6. Open a new terminal and go to your `aircaft` clone folder and run: `npm run serve:efb`
3939
This allows to see any changes to the instrument's code nearly instantaneously.
4040

4141
To interact with the EFB via mouse, you need to click enter to turn on interactive mode.

docs/dev-corner/development-projects/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ FlyByWire Simulations consists of several projects to allow efficient and quick
1111

1212
| Projects | Description |
1313
|:-----------------------------------------------------------------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
14-
| [A32NX](https://github.com/flybywiresim/a32nx){target=new} | Main project where the actual FlyByWire A32NX is developed |
14+
| [Aircraft](https://github.com/flybywiresim/aircraft){target=new} | Main project where the FlyByWire A32NX and A380X are developed |
1515
| [Installer](https://github.com/flybywiresim/installer){target=new} | Project for developing and improving the FlyByWire Installer. |
1616
| [Docs](documentation.md) | Documentation project to manage and improve documentation for our users. This includes documentation about the A32NX, general sim-pilot documentation, and documentation about development for the A32NX. |
1717
| [Discord Bot](discord-bot.md) | FlyByWire Simulations custom bot commands list and changelog. Provides a quick overview of available support commands and changes to bot development. |

docs/dev-corner/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ description: The Development Corner is dedicated to providing information about
99

1010
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.
1111

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

1414
## Quick Links
1515

docs/dev-corner/qa-process.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ To QA test for FlyByWire, you need the following prerequisites:
1616

1717
- Having read and understood this page!
1818
- Microsoft Flight Simulator (PC)
19-
- GitHub Account and access to our [Pull Requests](https://github.com/flybywiresim/a32nx/pulls){target=new}
19+
- GitHub Account and access to our [Pull Requests](https://github.com/flybywiresim/aircraft/pulls){target=new}
2020
- Discord Account and joined our server [FlyByWire Simulations](https://discord.gg/flybywire)
2121
- A QA Trainee or QA Tester Discord role
2222

@@ -40,7 +40,7 @@ To manage this process, we use the GitHub Project feature.
4040

4141
This is a simple Kanban board where items move from the left to the right. For QA tests, the third column is relevant ("QA Team Review: Ready to Test")
4242

43-
![QA Project Board on GitHub](assets/qa-process/qa-board.png "QA Project Board on GitHub"){loading=lazy}<br/>[QA Project Board on GitHub](https://github.com/flybywiresim/a32nx/projects/4){target=new}
43+
![QA Project Board on GitHub](assets/qa-process/qa-board.png "QA Project Board on GitHub"){loading=lazy}<br/>[QA Project Board on GitHub](https://github.com/flybywiresim/aircraft/projects/4){target=new}
4444

4545
If you have gotten a grasp on the above instructions, pick a PR to test from the list.
4646

@@ -109,7 +109,7 @@ Typically, it is ok to keep your Navigraph data installed.
109109

110110
Read the test instructions of the PR carefully. Focus only on what is requested and part of this PR. Do not bloat your reports with many additional observations.
111111

112-
If you find additional issues which are not part of the PR, reproduce and test them with the latest Development version and then create a [GitHub Issue](https://github.com/flybywiresim/a32nx/issues) for them.
112+
If you find additional issues which are not part of the PR, reproduce and test them with the latest Development version and then create a [GitHub Issue](https://github.com/flybywiresim/aircraft/issues) for them.
113113

114114
### Ask on Discord
115115

@@ -164,7 +164,7 @@ Media:
164164
!!! tip "Tip: Look at closed PRs"
165165
To better understand what a report should look like, you can look at closed PRs on GitHub to see how others approach this.
166166

167-
Link to Closed PR list: [Closed PRs](https://github.com/flybywiresim/a32nx/pulls?q=is%3Apr+is%3Aclosed){target=new}
167+
Link to Closed PR list: [Closed PRs](https://github.com/flybywiresim/aircraft/pulls?q=is%3Apr+is%3Aclosed){target=new}
168168

169169
!!! tip "Tip: Using GitHub Save for Template"
170170
We suggest using the "Saved Replies" feature of GitHub for the QA Template. You can set them up as follows:

docs/dev-corner/texture-changes.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ If you are the author of an affected livery, please reference the following:
1414
- For convenience, here is a copy of the [new sharklet UV map](assets/a32nx-dev/sharklet_uv_4k.png){target=new} that can be added as a layer in your workflow. The decals should be painted un-mirrored.
1515

1616
!!! warning ""
17-
For further context, you can review [pull request #5490](https://github.com/flybywiresim/a32nx/pull/5490){target=new} on our GitHub if necessary.
17+
For further context, you can review [pull request #5490](https://github.com/flybywiresim/aircraft/pull/5490){target=new} on our GitHub if necessary.
1818

1919
## Registration Decal
2020

@@ -34,7 +34,7 @@ If you are the author of a livery that has textured wheels, with text or anythin
3434
- No action is required. The current wheel texture will appear correct on the right main gear wheel.
3535

3636
!!! warning ""
37-
For further context, you can review [pull request #6931](https://github.com/flybywiresim/a32nx/pull/6931) on our GitHub if necessary.
37+
For further context, you can review [pull request #6931](https://github.com/flybywiresim/aircraft/pull/6931) on our GitHub if necessary.
3838

3939
## Cargo Hinges
4040

docs/fbw-a32nx/a32nx-api/a32nx-flightdeck-api.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,8 @@ hide:
1515

1616
Find the complete list of Custom Event and Custom LVARS of the A32NX:
1717

18-
- [Custom LVARs](https://github.com/flybywiresim/a32nx/blob/master/fbw-a32nx/docs/a320-simvars.md){target=new}
19-
- [Custom Events](https://github.com/flybywiresim/a32nx/blob/master/fbw-a32nx/docs/a320-events.md){target=new}
18+
- [Custom LVARs](https://github.com/flybywiresim/aircraft/blob/master/fbw-a32nx/docs/a320-simvars.md){target=new}
19+
- [Custom Events](https://github.com/flybywiresim/aircraft/blob/master/fbw-a32nx/docs/a320-events.md){target=new}
2020

2121
!!! note "The order of the panels below is roughly done after the standard cold & dark setup procedure."
2222

@@ -212,7 +212,7 @@ Flight Deck: [APU Panel](../../pilots-corner/a32nx-briefing/flight-deck/ovhd/apu
212212
| START | A32NX_OVHD_APU_START_PB_IS_ON | 0&#124;1 | R/W | Custom LVAR | |
213213
| | A32NX_OVHD_APU_START_PB_IS_AVAILABLE | 0&#124;1 | R | Custom LVAR | |
214214

215-
!!! note "Search for APU in our [list for all Custom LVARS](https://github.com/flybywiresim/a32nx/blob/master/fbw-a32nx/docs/a320-simvars.md){target=new} for further variables."
215+
!!! note "Search for APU in our [list for all Custom LVARS](https://github.com/flybywiresim/aircraft/blob/master/fbw-a32nx/docs/a320-simvars.md){target=new} for further variables."
216216

217217
### RCDR Panel
218218

docs/fbw-a32nx/a32nx-api/lvars-events.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,14 @@
22

33
Flight-Deck API Documentation: [Flight-Deck API](a32nx-flightdeck-api.md)
44

5-
In addition to the above documentation, all custom variables and custom events are documented by our developers on our project's GitHub: [:fontawesome-brands-github:{: .github } - **Docs section on GitHub**](https://github.com/flybywiresim/a32nx/tree/master/fbw-a32nx/docs){target=new}
5+
In addition to the above documentation, all custom variables and custom events are documented by our developers on our project's GitHub: [:fontawesome-brands-github:{: .github } - **Docs section on GitHub**](https://github.com/flybywiresim/aircraft/tree/master/fbw-a32nx/docs){target=new}
66

77
## Docs:
88

9-
- [Custom LVARs](https://github.com/flybywiresim/a32nx/blob/master/fbw-a32nx/docs/a320-simvars.md){target=new}
10-
- [Custom Events](https://github.com/flybywiresim/a32nx/blob/master/fbw-a32nx/docs/a320-events.md){target=new}
9+
- [Custom LVARs](https://github.com/flybywiresim/aircraft/blob/master/fbw-a32nx/docs/a320-simvars.md){target=new}
10+
- [Custom Events](https://github.com/flybywiresim/aircraft/blob/master/fbw-a32nx/docs/a320-events.md){target=new}
1111

1212
## Templates
1313

14-
- **SPAD.neXt:** [flybywire-aircraft-a320-neo.xml](https://github.com/flybywiresim/a32nx/tree/master/fbw-a32nx/docs/SPAD.neXt){target=new}
15-
- **FSUIPC:** [flybywire-aircraft-a320-neo.evt](https://github.com/flybywiresim/a32nx/tree/master/fbw-a32nx/docs/FSUIPC){target=new}
14+
- **SPAD.neXt:** [flybywire-aircraft-a320-neo.xml](https://github.com/flybywiresim/aircraft/tree/master/fbw-a32nx/docs/SPAD.neXt){target=new}
15+
- **FSUIPC:** [flybywire-aircraft-a320-neo.evt](https://github.com/flybywiresim/aircraft/tree/master/fbw-a32nx/docs/FSUIPC){target=new}

docs/fbw-a32nx/faq.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@
2929
No, it is a completely free and open-source aircraft.
3030

3131
??? info "Q: How do we report bugs?"
32-
Report bugs to us in the [Discord server](https://discord.gg/flybywire){target=new}, under the `#a32nx-support` channel, or by creating a [GitHub issue](https://github.com/flybywiresim/a32nx/issues/new/choose){target=new}.
32+
Report bugs to us in the [Discord server](https://discord.gg/flybywire){target=new}, under the `#a32nx-support` channel, or by creating a [GitHub issue](https://github.com/flybywiresim/aircraft/issues/new/choose){target=new}.
3333

3434
Just make sure to search for existing issues first before creating a new one.
3535

0 commit comments

Comments
 (0)