FBW User Documentation

Future integration to proper repository pending. Currently running this as a demo and primer for official FBW user documentation.

Main FlyByWire Simulations Repo

Disclaimer: Current organization of docs_dir is not final. Recommendation is to create sub-directories as project expands to organize documents on the repo. Based on Admin/Team Feedback. i.e.

├─ docs/
│  └─ index.md
│  └─ Installation Guide/
│     └─ sample.md
│     └─ sample.md
│  └─ A32NX Limitations/
│     └─ sample.md
│     └─ sample.md
│  └─ Contributing Guides/
│     └─ sample.md
└─ mkdocs.yml

Recommended Reading

Main documentation

• MkDocs Documentation

Theme Documentation

• MkDocs-Material
• References for various styling through dependency integrations
• MkDocs-Material-References

Contributing

1. Fork repo
2. Clone to your local system
3. Make a new branch
4. Edit the .md you plan on adding changes too.
5. Use editor of choice to preview your .md
6. Submit PR.

Editing Methods

Adding new Pages/Documentation

Recommend getting mkdocs setup locally to be able to preview your work via mkdocs serve and/or build a local copy of the site mkdocs build for testing.

You can still build and add pages to repo by simply:

1. Adding the sample.md to the appropriate location.
2. Adding the sample.md to the mkdocs.yml to the appropriate nav section. More info below.

nav:
 - Home: index.md
 /// Below is a section. Must NOT have a .md attached
 - Installation Guide:
   /// This is a nestled page under the section.
   - Downloads + Guide: guide.md
 - Donate: donate.md
 - FAQ: faq.md

Format is Title: filename.md

Testing deployment Locally

If you want to preview your build while you edit follow the instructions below. This is also mandatory if you want to style the documents or propose changes to the branding of the mkdocs.

• Requires Python -> Installer
  • Supports Python 3.5, 3.6, 3.7, 3.8 and pyp3.
• Use pip installation for general compatibility with mkdocs-material theme.
  • Upgrade - pip install --upgrade pip
  • Install pip - python get-pip.py // recent versions of Python should come bundled with pip.
• This repo is using mkdocs-material as a theme.
  • Run pip install mkdocs-material

You should be setup at this point to locally view your changes as you apply them.

• Use mkdocs serve and visit localhost:8000 to preview the documentation site as you made edits.
• Site renders as you save any .md you are working on or as you save changes to css stylesheets / mkdocs.yml.

If you want to test the build before pushing your PR upstream

• Use mkdocs build and the site will be built locally with index.html on in your local repo for user testing.