Skip to content

Commit

Permalink
build: bump mkdocs-material -> 9.2.1
Browse files Browse the repository at this point in the history
* 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
  • Loading branch information
Valastiri authored Aug 25, 2023
1 parent 542bcd5 commit 7dc953e
Show file tree
Hide file tree
Showing 12 changed files with 34 additions and 28 deletions.
10 changes: 5 additions & 5 deletions docs/dev-corner/dev-guide/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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. |

4 changes: 2 additions & 2 deletions docs/dev-corner/development-projects/documentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
12 changes: 6 additions & 6 deletions docs/dev-corner/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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) |

2 changes: 1 addition & 1 deletion docs/dev-corner/texture-changes.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
8 changes: 4 additions & 4 deletions docs/fbw-a32nx/fbw-versions.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand All @@ -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 -** <img src="https://img.shields.io/github/v/release/flybywiresim/aircraft.svg?color=2F4E5B&style=flat" />
Expand All @@ -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:

Expand Down
5 changes: 3 additions & 2 deletions docs/fbw-a32nx/feature-guides/flypados3/settings.md
Original file line number Diff line number Diff line change
Expand Up @@ -234,8 +234,9 @@ Settings for integrations with various 3rd party applications
<span class="imagesub">Click on the menu icons in this image to see other flyPad pages.</span>
</div>

!!! 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]&#40;../../fbw-versions.md#development-version-recommended&#41;)

#### GSX Integration
These options are separate to provide you with the flexibility to choose what to sync with GSX and what not to sync.
Expand Down
5 changes: 3 additions & 2 deletions docs/fbw-a32nx/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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) |



Original file line number Diff line number Diff line change
Expand Up @@ -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 ""
Expand Down
4 changes: 2 additions & 2 deletions docs/stylesheets/navigation.css
Original file line number Diff line number Diff line change
Expand Up @@ -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 */
Expand Down
3 changes: 3 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -116,6 +117,8 @@ extra_css:

# Extra Functions / Customizations
extra:
status:
new: Recently Updated
social:
- icon: fontawesome/brands/github
link: https://github.com/flybywiresim
Expand Down
3 changes: 2 additions & 1 deletion overrides/home.html
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,8 @@
<div class="hero">
<div class="hero-content">
<h1> FlyByWire Documentation </h1>
<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>
<p>Welcome to the documentation and guides website for FlyByWire Simulations open source, community-driven projects.</p>
<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>
<a href="{{ page.next_page.url | url }}" title="{{ page.next_page.title | striptags }}" class="md-button md-button--primary">
Start Here
</a>
Expand Down
4 changes: 2 additions & 2 deletions requirements.txt
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -7,4 +7,4 @@ mkdocs-video
mkdocs-glightbox
pillow
cairosvg
urllib3==1.26.15
urllib3<2.0

1 comment on commit 7dc953e

@vercel
Copy link

@vercel vercel bot commented on 7dc953e Aug 25, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Successfully deployed to the following URLs:

docs – ./

docs-flybywire.vercel.app
docs.flybywiresim.com
docs-git-primary-flybywire.vercel.app

Please sign in to comment.