-
-
Notifications
You must be signed in to change notification settings - Fork 1.1k
docs: Revisions to documentation, A380X referencing, file structure consolidation, and optimised naming conventions #10338
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
base: master
Are you sure you want to change the base?
Conversation
- Updated file name from Contributing.md to CONTRIBUTING.md, in-line with FlyByWire naming conventions. - Updated document to more thoroughly include references to the A380X, closing issue flybywiresim#10337. - Minor tweaks to sentence structure throughout document to enhance readability.
Changed filename to UPPERCASE format, inline with established documentation naming convention. Reference in CONTRIBUTING.md updated.
Updated CHANGELOG to include broader documentation changes.
|
I have pushed additional changes to address RESOURCES.md. The file has been updated to follow the established naming convention and consolidated into the .github folder with other general development documentation. |
|
Unfortunately changing only the case of file names is problematic for windows so I wouldn’t recommend that. The phrasing improvements look good. The changelog is not necessary as these changes are for developers only. |
|
Hey @tracernz, the RESOURCES.md and CONTRIBUTING.md files have been moved from './fbw-a32nx/docs' to './.github' thus are technically new files. This is because they are general development documentation and not applicable only to the A32NX project. Would this still be problematic with this in mind? I will revert the changelog file. |
Fixes #10337
Summary of Changes
Updated file name from Contributing.md to CONTRIBUTING.md and Resources.md to RESOURCES.md, in-line with FlyByWire naming conventions.
Consolidated general development documentation into to .github folder.
Updated CONTRIBUTING.md document to more thoroughly include references to the A380X, with minor tweaks to sentence structure throughout document to enhance readability.
Updated README.md to ensure correct hyperlink attributes.
Included change in CHANGELOG.md (not sure if this is necessary given the scope of the changes, feel free to remove)
Screenshots (if necessary)
References
Additional context
Additional hyperlink references may need to be updated by an admin, such as these notices:
Discord username (if different from GitHub):
YouBaconMeCrazy
Testing instructions
Links may be tested in the README.md file by clicking through and ensuring there is not a NoPage error.
How to download the PR for QA
Every new commit to this PR will cause new A32NX and A380X artifacts to be created, built, and uploaded.