Skip to content

Commit 7dc953e

Browse files
ValastiriValastiri
authored
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
1 parent 542bcd5 commit 7dc953e

File tree

12 files changed

+34
-28
lines changed

12 files changed

+34
-28
lines changed

‎docs/dev-corner/dev-guide/index.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -28,10 +28,10 @@ tools, downloading and compiling the A32NX successfully to guidelines how to con
2828

2929
## Topics
3030

31-
| Quick Links | Description |
32-
|:-----------------------------------------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------|
33-
| [Resources](resources.md) | General information and documentation resources |
31+
| Quick Links | Description |
32+
|:---------------------------------------------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------|
33+
| [Resources](resources.md) | General information and documentation resources |
3434
| [Setting up the Development Environment](setup-environment.md) | From software to troubleshooting - everything you need to successfully change and compile the code. |
35-
| [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. |
36-
| [Specific Development Areas](specific/) | Information for specific parts of the project like the flyPad or avionics. |
35+
| [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. |
36+
| [Specific Development Areas](specific/index.md) | Information for specific parts of the project like the flyPad or avionics. |
3737

‎docs/dev-corner/development-projects/documentation.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -119,11 +119,11 @@ feature.
119119
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.
120120
121121
```
122-
mkdocs.exe serve --dirtyreload
122+
mkdocs.exe serve --dirty
123123
```
124124
125125
!!! danger ""
126-
Navigation and new internal links may not get updated on other pages while using `--dirtyreload`. Verify links using the standard serve or build command.
126+
Navigation and new internal links may not get updated on other pages while using `--dirty`. Verify links using the standard serve or build command.
127127
128128
- 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.
129129
- Optional: Build a static site locally for testing:

‎docs/dev-corner/index.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -13,10 +13,10 @@ This section of the FlyByWire Documentation is dedicated to the development aspe
1313

1414
## Quick Links
1515

16-
| Topics |
17-
|:--------------------------------------------|
18-
| [Development Guide](dev-guide/index.md) |
19-
| [Texture Changes](texture-changes.md) |
20-
| [Scenery Developers](scenery-developers.md) |
21-
| [FlyByWire Projects](development-projects/) |
16+
| Topics |
17+
|:----------------------------------------------------|
18+
| [Development Guide](dev-guide/index.md) |
19+
| [Texture Changes](texture-changes.md) |
20+
| [Scenery Developers](scenery-developers.md) |
21+
| [FlyByWire Projects](development-projects/index.md) |
2222

‎docs/dev-corner/texture-changes.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ The A32NX has a [toggle option in the EFB to disable the dynamic registration nu
2323
!!! warning "Avoid Using panel.cfg"
2424
Overriding `panel.cfg` creates future conflicts with A32NX development.
2525

26-
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).
26+
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).
2727

2828
## Mirrored Wheel Texture
2929

‎docs/fbw-a32nx/fbw-versions.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
## Version Overview
44

5-
### "Development Version (recommended)"
5+
### Development Version (recommended)
66

77
Development will have the latest features that will eventually end up in the next stable release.
88

@@ -14,7 +14,7 @@ Every addition to the development version is code-reviewed and tested by several
1414

1515
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}
1616

17-
### "Stable Version"
17+
### Stable Version
1818

1919
!!! info ""
2020
**Current Stable Version -** <img src="https://img.shields.io/github/v/release/flybywiresim/aircraft.svg?color=2F4E5B&style=flat" />
@@ -23,13 +23,13 @@ Stable is our version which contains features that are the most mature and most
2323

2424
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.
2525

26-
### "Experimental Version"
26+
### Experimental Version
2727

2828
We have discontinued our Experimental Version. Latest features and testing will be on the Development Version of the aircraft.
2929

3030
## Version Comparison
3131

32-
See [Latest Release Notes for Stable](/latest-release)
32+
See [Latest Release Notes for Stable](/latest-release/)
3333

3434
For all changes made to the Development version since the last major release of the Stable version, refer to:
3535

‎docs/fbw-a32nx/feature-guides/flypados3/settings.md

+3-2
Original file line numberDiff line numberDiff line change
@@ -234,8 +234,9 @@ Settings for integrations with various 3rd party applications
234234
<span class="imagesub">Click on the menu icons in this image to see other flyPad pages.</span>
235235
</div>
236236

237-
!!! warning ""
238-
This feature is only available in the [Development Version](../../fbw-versions.md#development-version-recommended)
237+
[//]: # (!!! warning "")
238+
239+
[//]: # ( This feature is only available in the [Development Version]&#40;../../fbw-versions.md#development-version-recommended&#41;)
239240

240241
#### GSX Integration
241242
These options are separate to provide you with the flexibility to choose what to sync with GSX and what not to sync.

‎docs/fbw-a32nx/index.md

+3-2
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ Engine CFM LEAP 1A-26
2121
APU APS3200
2222
FMS Honeywell Release H3
2323
FWC Std. H2F13
24+
RA Honeywell ALA-52B
2425
TAWS Honeywell EGPWS
2526
ACAS Honeywell TPA-100B
2627
ATC Honeywell TRA-100B
@@ -37,12 +38,12 @@ WXR Honeywell RDR-4000
3738
## Topics
3839

3940
| Featured List |
40-
| :---- |
41+
|:---------------------------------------------|
4142
| [Installation Guide](installation.md) |
4243
| [Version and Feature Guide](fbw-versions.md) |
4344
| [Livery Guide](liveries.md) |
4445
| [Support](support/index.md) |
45-
| [API and Hardware](a32nx-api) |
46+
| [API and Hardware](a32nx-api/index.md) |
4647

4748

4849

‎docs/simbridge/simbridge-feature-guides/remote-displays/remote-mcdu.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ It also allows you to use your real printer as a cockpit printer for the MCDU.
1919
Please note the following requirements before trying to use this feature:
2020

2121
- SimBridge *must* be [running](../../install-configure/start-simbridge.md#autostart) in order to connect remotely.
22-
- See [Autostart](../../install-configure/start-simbridge#autostart) documentation on how to start it.
22+
- See [Autostart](../../install-configure/start-simbridge.md#autostart) documentation on how to start it.
2323
- Check [Troubleshooting](../../troubleshooting.md) if you are having issues.
2424

2525
!!! tip ""

‎docs/stylesheets/navigation.css

+2-2
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,9 @@
1313
color: #ffffff;
1414
background-color: #1F2A3C;
1515
}
16-
.md-tabs__link--active, .md-tabs__link:focus, .md-tabs__link:hover {
16+
17+
.md-tabs__item--active, .md-tabs__item:focus, .md-tabs__item:hover {
1718
border-bottom: 1.5px solid #00E0FE;
18-
height: -webkit-fill-available;
1919
}
2020

2121
/* Sidebar Navigation Modifications */

‎mkdocs.yml

+3
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@ theme:
2323
scheme: slate
2424
primary: custom
2525
features:
26+
- navigation.prune
2627
- navigation.tabs
2728
- navigation.tabs.sticky
2829
# Removed this feature again as it's breaking TOC navigation on reported-issues.md
@@ -116,6 +117,8 @@ extra_css:
116117

117118
# Extra Functions / Customizations
118119
extra:
120+
status:
121+
new: Recently Updated
119122
social:
120123
- icon: fontawesome/brands/github
121124
link: https://github.com/flybywiresim

‎overrides/home.html

+2-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,8 @@
88
<div class="hero">
99
<div class="hero-content">
1010
<h1> FlyByWire Documentation </h1>
11-
<p>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.</p>
11+
<p>Welcome to the documentation and guides website for FlyByWire Simulations open source, community-driven projects.</p>
12+
<p>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!</p>
1213
<a href="{{ page.next_page.url | url }}" title="{{ page.next_page.title | striptags }}" class="md-button md-button--primary">
1314
Start Here
1415
</a>

‎requirements.txt

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
mkdocs-material==9.1.21
1+
mkdocs-material==9.2.1
22
mkdocs-awesome-pages-plugin
33
mkdocs-git-revision-date-localized-plugin
44
mkdocs-redirects
@@ -7,4 +7,4 @@ mkdocs-video
77
mkdocs-glightbox
88
pillow
99
cairosvg
10-
urllib3==1.26.15
10+
urllib3<2.0

0 commit comments

Comments
 (0)