From 7dc953e418776b94691a96cdf326f5debf1844c6 Mon Sep 17 00:00:00 2001 From: Val Date: Fri, 25 Aug 2023 16:58:16 +0800 Subject: [PATCH 1/2] build: bump mkdocs-material -> 9.2.1 * build: bump mkdocs-material -> 9.2.1 * make urllib3 dependency target <2.0 * enable navigation pruning * navigation status using faq.md as sample * remove quotation marks in headers fbw-versions.md * update simulated hardware a32nx overview * fix navigation.css border-bottom * bump -> 9.2.0b1 * mkdocs-material -> 9.2.0b2 * update documentation.md with new dirty flag * clean up INFO messages when serve or building * bump beta -> 9.2.0b3 * update homepage summary blurb * split text in hero blurb main page * minor text changes to hero * refactor status config * remove sample status symbol from faq.md * bump version 9.2.1 * remove GSX dev version only admonition * update --dirty flag information in documentation.md --- docs/dev-corner/dev-guide/index.md | 10 +++++----- .../dev-corner/development-projects/documentation.md | 4 ++-- docs/dev-corner/index.md | 12 ++++++------ docs/dev-corner/texture-changes.md | 2 +- docs/fbw-a32nx/fbw-versions.md | 8 ++++---- docs/fbw-a32nx/feature-guides/flypados3/settings.md | 5 +++-- docs/fbw-a32nx/index.md | 5 +++-- .../remote-displays/remote-mcdu.md | 2 +- docs/stylesheets/navigation.css | 4 ++-- mkdocs.yml | 3 +++ overrides/home.html | 3 ++- requirements.txt | 4 ++-- 12 files changed, 34 insertions(+), 28 deletions(-) diff --git a/docs/dev-corner/dev-guide/index.md b/docs/dev-corner/dev-guide/index.md index aa536518b..be9889464 100644 --- a/docs/dev-corner/dev-guide/index.md +++ b/docs/dev-corner/dev-guide/index.md @@ -28,10 +28,10 @@ tools, downloading and compiling the A32NX successfully to guidelines how to con ## Topics -| Quick Links | Description | -|:-----------------------------------------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------| -| [Resources](resources.md) | General information and documentation resources | +| Quick Links | Description | +|:---------------------------------------------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------| +| [Resources](resources.md) | General information and documentation resources | | [Setting up the Development Environment](setup-environment.md) | From software to troubleshooting - everything you need to successfully change and compile the code. | -| [Contribution Guidelines](contribute.md) | From General Development Process and Practices to Pull Requests - everything you need to know to collaborate and contribute to the project. | -| [Specific Development Areas](specific/) | Information for specific parts of the project like the flyPad or avionics. | +| [Contribution Guidelines](contribute.md) | From General Development Process and Practices to Pull Requests - everything you need to know to collaborate and contribute to the project. | +| [Specific Development Areas](specific/index.md) | Information for specific parts of the project like the flyPad or avionics. | diff --git a/docs/dev-corner/development-projects/documentation.md b/docs/dev-corner/development-projects/documentation.md index 45a1593fb..a007c9cda 100644 --- a/docs/dev-corner/development-projects/documentation.md +++ b/docs/dev-corner/development-projects/documentation.md @@ -119,11 +119,11 @@ feature. You can opt to use a faster instance of the developer server by invoking the flag `--dirtyreload`. This just checks for any markdown that has changed since the HTML was rendered and will reconstruct any relevant pages only, rather than rebuilding the entire website. ``` - mkdocs.exe serve --dirtyreload + mkdocs.exe serve --dirty ``` !!! danger "" - Navigation and new internal links may not get updated on other pages while using `--dirtyreload`. Verify links using the standard serve or build command. + Navigation and new internal links may not get updated on other pages while using `--dirty`. Verify links using the standard serve or build command. - You can now browse the current checked out branch in a browser at this address: [http://127.0.0.1:8000/](http://127.0.0.1:8000/). The site renders every time you save any `filename.md` you are working on. - Optional: Build a static site locally for testing: diff --git a/docs/dev-corner/index.md b/docs/dev-corner/index.md index e60847417..072e3dd6c 100644 --- a/docs/dev-corner/index.md +++ b/docs/dev-corner/index.md @@ -13,10 +13,10 @@ This section of the FlyByWire Documentation is dedicated to the development aspe ## Quick Links -| Topics | -|:--------------------------------------------| -| [Development Guide](dev-guide/index.md) | -| [Texture Changes](texture-changes.md) | -| [Scenery Developers](scenery-developers.md) | -| [FlyByWire Projects](development-projects/) | +| Topics | +|:----------------------------------------------------| +| [Development Guide](dev-guide/index.md) | +| [Texture Changes](texture-changes.md) | +| [Scenery Developers](scenery-developers.md) | +| [FlyByWire Projects](development-projects/index.md) | diff --git a/docs/dev-corner/texture-changes.md b/docs/dev-corner/texture-changes.md index 4b5ddf080..7f89e56ad 100644 --- a/docs/dev-corner/texture-changes.md +++ b/docs/dev-corner/texture-changes.md @@ -23,7 +23,7 @@ The A32NX has a [toggle option in the EFB to disable the dynamic registration nu !!! warning "Avoid Using panel.cfg" Overriding `panel.cfg` creates future conflicts with A32NX development. - Please avoid using `panel.cfg` to disable the registration number decal, and instead advise users to [disable the dynamic decal in the EFB settings](../../fbw-a32nx/feature-guides/flypados3/settings/#sim-options). + Please avoid using `panel.cfg` to disable the registration number decal, and instead advise users to [disable the dynamic decal in the EFB settings](../fbw-a32nx/feature-guides/flypados3/settings.md#sim-options). ## Mirrored Wheel Texture diff --git a/docs/fbw-a32nx/fbw-versions.md b/docs/fbw-a32nx/fbw-versions.md index 43a502a4c..a525fd419 100644 --- a/docs/fbw-a32nx/fbw-versions.md +++ b/docs/fbw-a32nx/fbw-versions.md @@ -2,7 +2,7 @@ ## Version Overview -### "Development Version (recommended)" +### Development Version (recommended) Development will have the latest features that will eventually end up in the next stable release. @@ -14,7 +14,7 @@ Every addition to the development version is code-reviewed and tested by several The latest additions to this version can be seen either in the official [CHANGELOG](https://github.com/flybywiresim/aircraft/blob/master/.github/CHANGELOG.md) or the commits to the master branch of the project: [GitHub Commits to Master](https://github.com/flybywiresim/aircraft/commits/master){target=new} -### "Stable Version" +### Stable Version !!! info "" **Current Stable Version -** @@ -23,13 +23,13 @@ Stable is our version which contains features that are the most mature and most This version will not always be up-to-date, but we work hard at ensuring its compatibility with the current version of Microsoft Flight Simulator. -### "Experimental Version" +### Experimental Version We have discontinued our Experimental Version. Latest features and testing will be on the Development Version of the aircraft. ## Version Comparison -See [Latest Release Notes for Stable](/latest-release) +See [Latest Release Notes for Stable](/latest-release/) For all changes made to the Development version since the last major release of the Stable version, refer to: diff --git a/docs/fbw-a32nx/feature-guides/flypados3/settings.md b/docs/fbw-a32nx/feature-guides/flypados3/settings.md index e13f384ac..270fc7285 100644 --- a/docs/fbw-a32nx/feature-guides/flypados3/settings.md +++ b/docs/fbw-a32nx/feature-guides/flypados3/settings.md @@ -234,8 +234,9 @@ Settings for integrations with various 3rd party applications Click on the menu icons in this image to see other flyPad pages. -!!! warning "" - This feature is only available in the [Development Version](../../fbw-versions.md#development-version-recommended) +[//]: # (!!! warning "") + +[//]: # ( This feature is only available in the [Development Version](../../fbw-versions.md#development-version-recommended)) #### GSX Integration These options are separate to provide you with the flexibility to choose what to sync with GSX and what not to sync. diff --git a/docs/fbw-a32nx/index.md b/docs/fbw-a32nx/index.md index 83d67148d..8b207e774 100644 --- a/docs/fbw-a32nx/index.md +++ b/docs/fbw-a32nx/index.md @@ -21,6 +21,7 @@ Engine CFM LEAP 1A-26 APU APS3200 FMS Honeywell Release H3 FWC Std. H2F13 +RA Honeywell ALA-52B TAWS Honeywell EGPWS ACAS Honeywell TPA-100B ATC Honeywell TRA-100B @@ -37,12 +38,12 @@ WXR Honeywell RDR-4000 ## Topics | Featured List | -| :---- | +|:---------------------------------------------| | [Installation Guide](installation.md) | | [Version and Feature Guide](fbw-versions.md) | | [Livery Guide](liveries.md) | | [Support](support/index.md) | -| [API and Hardware](a32nx-api) | +| [API and Hardware](a32nx-api/index.md) | diff --git a/docs/simbridge/simbridge-feature-guides/remote-displays/remote-mcdu.md b/docs/simbridge/simbridge-feature-guides/remote-displays/remote-mcdu.md index 4040d679c..0da352a71 100644 --- a/docs/simbridge/simbridge-feature-guides/remote-displays/remote-mcdu.md +++ b/docs/simbridge/simbridge-feature-guides/remote-displays/remote-mcdu.md @@ -19,7 +19,7 @@ It also allows you to use your real printer as a cockpit printer for the MCDU. Please note the following requirements before trying to use this feature: - SimBridge *must* be [running](../../install-configure/start-simbridge.md#autostart) in order to connect remotely. - - See [Autostart](../../install-configure/start-simbridge#autostart) documentation on how to start it. + - See [Autostart](../../install-configure/start-simbridge.md#autostart) documentation on how to start it. - Check [Troubleshooting](../../troubleshooting.md) if you are having issues. !!! tip "" diff --git a/docs/stylesheets/navigation.css b/docs/stylesheets/navigation.css index 37c51bd5e..540fcf829 100644 --- a/docs/stylesheets/navigation.css +++ b/docs/stylesheets/navigation.css @@ -13,9 +13,9 @@ color: #ffffff; background-color: #1F2A3C; } -.md-tabs__link--active, .md-tabs__link:focus, .md-tabs__link:hover { + +.md-tabs__item--active, .md-tabs__item:focus, .md-tabs__item:hover { border-bottom: 1.5px solid #00E0FE; - height: -webkit-fill-available; } /* Sidebar Navigation Modifications */ diff --git a/mkdocs.yml b/mkdocs.yml index 31e2ddd91..d54c4b907 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -23,6 +23,7 @@ theme: scheme: slate primary: custom features: + - navigation.prune - navigation.tabs - navigation.tabs.sticky # Removed this feature again as it's breaking TOC navigation on reported-issues.md @@ -116,6 +117,8 @@ extra_css: # Extra Functions / Customizations extra: + status: + new: Recently Updated social: - icon: fontawesome/brands/github link: https://github.com/flybywiresim diff --git a/overrides/home.html b/overrides/home.html index 263d78e76..54fa36675 100644 --- a/overrides/home.html +++ b/overrides/home.html @@ -8,7 +8,8 @@

FlyByWire Documentation

-

Welcome to the documentation and guides for FlyByWire Simulations open source community-driven projects. Here you'll find plenty of resources that help you to pilot and use our aircraft or contribute towards development of ongoing FlyByWire projects.

+

Welcome to the documentation and guides website for FlyByWire Simulations open source, community-driven projects.

+

You'll find plenty of resources that help you pilot and use our aircraft. You can also find information on how to contribute to ongoing FlyByWire projects!

Start Here diff --git a/requirements.txt b/requirements.txt index 57b6fa64c..71cbff50c 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,4 +1,4 @@ -mkdocs-material==9.1.21 +mkdocs-material==9.2.1 mkdocs-awesome-pages-plugin mkdocs-git-revision-date-localized-plugin mkdocs-redirects @@ -7,4 +7,4 @@ mkdocs-video mkdocs-glightbox pillow cairosvg -urllib3==1.26.15 \ No newline at end of file +urllib3<2.0 \ No newline at end of file From 340182da2b0865fa590a0f18f9d60783e649719e Mon Sep 17 00:00:00 2001 From: Frank Kopp Date: Mon, 28 Aug 2023 19:33:09 +0200 Subject: [PATCH 2/2] docs: Added instruments page and temp removed outdated flypad-dev page --- docs/dev-corner/dev-guide/specific/.pages | 3 ++- docs/dev-corner/dev-guide/specific/instruments.md | 7 +++++++ 2 files changed, 9 insertions(+), 1 deletion(-) create mode 100644 docs/dev-corner/dev-guide/specific/instruments.md diff --git a/docs/dev-corner/dev-guide/specific/.pages b/docs/dev-corner/dev-guide/specific/.pages index 81ad55349..35a664c20 100644 --- a/docs/dev-corner/dev-guide/specific/.pages +++ b/docs/dev-corner/dev-guide/specific/.pages @@ -1,6 +1,7 @@ title: Specific nav: - index.md - - flypad-dev.md +# - flypad-dev.md + - instruments.md - flypad-translations.md - javascript.md diff --git a/docs/dev-corner/dev-guide/specific/instruments.md b/docs/dev-corner/dev-guide/specific/instruments.md new file mode 100644 index 000000000..3a33b9571 --- /dev/null +++ b/docs/dev-corner/dev-guide/specific/instruments.md @@ -0,0 +1,7 @@ +# Instruments Build Guide + +This page is pulled externally from the FBW Aircraft repository and describes the processes of building the instruments. + +--- + +{{ external_markdown('https://raw.githubusercontent.com/flybywiresim/aircraft/master/fbw-a32nx/src/systems/instruments/README.md', '') }} \ No newline at end of file