Skip to content
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

refactor: prepare for v2 docs #27

Draft
wants to merge 15 commits into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
47 changes: 47 additions & 0 deletions .github/workflows/build-validation.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
name: Strict Build Validation

on:
pull_request_target:
types: [opened, ready_for_review]

jobs:
validate:
# Prevent running this on forks
if: github.repository_owner == 'heavy-division'
runs-on: ubuntu-latest
steps:
- name: Get PR SHA
id: sha
uses: actions/github-script@v5
with:
result-encoding: string
script: |
const { owner, repo, number } = context.issue;
const pr = await github.rest.pulls.get({
owner,
repo,
pull_number: number,
});
return pr.data.head.sha
- uses: actions/checkout@v2
with:
ref: ${{ steps.sha.outputs.result }}
fetch-depth: 0
- name: Make Build
uses: actions/setup-python@v2
with:
python-version: 3.x
- run: |
pip install -r requirements.txt
mkdocs build -s
- name: Message failure
if: ${{ failure() }}
uses: actions/github-script@v5
with:
script: |
github.rest.issues.createComment({
issue_number: context.issue.number,
owner: context.repo.owner,
repo: context.repo.repo,
body: 'Strict Build Failed! ❌ - Please checkout this PR locally to fix the issue before merging or see checks.',
});
Empty file.
13 changes: 13 additions & 0 deletions .github/workflows/pr-labeler.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
name: "Pull Request Labeler"
on:
pull_request_target:
types: [opened, reopened, ready_for_review, edited]

jobs:
triage:
runs-on: ubuntu-latest
steps:
- uses: actions/labeler@v3
with:
repo-token: "${{ secrets.GITHUB_TOKEN }}"
configuration-path: .github/labeler.yml
5 changes: 5 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
/.idea/
/site/
/.cache/

# Compiled class file
*.class

Expand All @@ -21,3 +25,4 @@

# virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml
hs_err_pid*

14 changes: 0 additions & 14 deletions _config.yml

This file was deleted.

15 changes: 0 additions & 15 deletions docs/B78XH/.pages

This file was deleted.

1 change: 0 additions & 1 deletion docs/B78XH/faq.md

This file was deleted.

File renamed without changes.
11 changes: 0 additions & 11 deletions docs/B78XH/support/.pages

This file was deleted.

File renamed without changes.
1 change: 1 addition & 0 deletions docs/CNAME
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
docs.hdsimulations.com
Binary file added docs/assets/flaps.PNG
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/fmc_preflight_complete.PNG
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
File renamed without changes.
22 changes: 22 additions & 0 deletions docs/faq.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# FAQ

### Where is the plane in the hangar?
The B78XH is a modification of the default premium deluxe aircraft, you need to own the premium deluxe version of MSFS to use the Heavy Division Mod.

### Where can I download the B78XH addon?
You can download the Stable, Development and Experimental builds from our [discord]() or [website]() You can also download the addon directly from the GitHub Repository to install manually.

### When is the Next Update?
We don't know when the next update will be, however you can keep up to date with development by checking our [updates broadcast]() channel in Discord.

### How do I join the team?
You can send an application to our [Google Form,]() and we'll try to get back to you as soon as possible if you're a good fit for the role.

### Does the Mod cost money?
No, it is completely free and open-source.

### Where do we report bugs?
Please submit bug reports as [issues]() using our GitHub issue-ticket system.

### I am a real life Aero Engineer, GA, B787-8/9/10 Pilot, or Cabin Crew. Where do I get my role?
Simply DM one of our staff on Discord with proof of your job!
Empty file added docs/index.mdx
Empty file.
File renamed without changes.
17 changes: 0 additions & 17 deletions docs/pilots-corner/beginner-guide/.pages

This file was deleted.

39 changes: 0 additions & 39 deletions docs/pilots-corner/beginner-guide/overview.md

This file was deleted.

Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
# Boeing Standard Abbreviations

## [A](#A) [B](#B) [C](#C) [D](#D) [E](#E) [F](#F) [G](#G) [H](#H) [I](#I) [K](#K) [L](#L) [M](#M) [N](#N) [O](#O) [P](#P) [Q](#Q) [R](#R) [S](#S) [T](#T) [U](#U) [V](#V) [W](#w) [X](#X) [Z](#Z)

# A

| Symbol | Meaning |
Expand Down Expand Up @@ -75,7 +73,7 @@

# C

| Symbol | Meaning |
| Symbol | Meaning |
|----------------|---------------------------------------------------------|
| C | Captain <br/>Celsius <br/>Center |
| CAB | Cabin |
Expand Down
54 changes: 54 additions & 0 deletions docs/pilots-guide/beginner-guide/overview.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
---
title: B78XH Beginner Guide - Overview
description: The B78XH Beginner Guide teaches users how to operate and fly the Heavy Division B78XH aircraft.
---

<link rel="stylesheet" href="../../../stylesheets/toc-tables.css">

# Overview

Welcome to the B78XH Beginner's Guide. Although this guide is tailored towards beginners, each this guide may serve as a useful refresher for veteran sim pilots.

Each page was reviewed by a 787 type rated pilot and provides accurate information to aircraft operation.

{--

The [Preflight](preflight.md) page contains guides on how to set up relevant data and configurations before starting your flight. We recommend starting there.

--}

!!! info "Airline SOP"
Please be aware that different airlines may have slightly different procedures at different stages of flight.

**For Simulation Use Only**

---

| Topics |
|:-----------------------------------------------------|
| [Preflight](preflight.mdx) |
| [Starting the Aircraft](powering-the-aircraft.mdx) |
| [Preparing the FMC](preparing-fmc.mdx) |
| [Engine Start and Taxi](engine-start-taxi.mdx) |
| [Takeoff, Climb and Cruise](takeoff-climb-cruise.mdx) |
| [Descent Planning and Descent](descent.mdx) |
| [Approach and ILS Landing](landing.mdx) |
| [After Landing and Taxi to Gate](after-landing.mdx) |
| [Powering Down](powering-down.mdx) |
| [Abbreviations](../abbreviations.mdx) |

---

If you have any issues or feedback with this guide, please file an issue here:

[:fontawesome-brands-github:{: .github } - **Heavy Division Docs Issues**](https://github.com/Heavy-Division/docs/issues){target=new}

For general questions please visit our Discord:

[:fontawesome-brands-discord:{: .discord } - **Discord Link**](https://discord.gg/ZtbHT7jkMW){target=new}

---

Authors: HowNowBrownCrow#2591

Guide reviewed by 787 Pilots.
68 changes: 68 additions & 0 deletions docs/pilots-guide/beginner-guide/powering-the-aircraft.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
# Starting the Aircraft

> Several acronyms are used in this guide to refer to specific components of the aircraft. Check the [Boeing abbreviations dictionary](docs_hd/docs/pilots-guide/abbreviations.md) for terms that seem unfamiliar.

> Some flight deck model behaviors have not been implemented yet. We will update this guide as more functionality is added, but for now the scope of this guide is to cover the capabilities of our aircraft.

## Cockpit Preparation
Begin by scanning the [bottom pedestal]()
* Check that the [parking brake]() is engaged (UP position)
* Ensure the [Speed Brakes]() are disarmed and retracted
* [Flaps]() are retracted
* [Engine Master Switches 1 and 2]() are both off
* [Engine Ignition]() knobs are in the `OFF` position
* [Thrust Levers]() are set to idle

Next, move to the **center panel** and ensure the [gear lever]() is set to `DOWN`.

Finally, move to the overhead panel and check that both the Captain's and First Officer's wipers are in the `OFF` position.

## Overhead Panel

## Electrical
It's necessary to supply electrical power to the aircraft in order to use any of the flight systems.
First, open the battery switch to supply power from the aircraft's main battery. Then turn on any one of the three external power switches.
If flying at night, this is a good time to familiarize yourself with the [flight deck and panel brightness lights]() and adjust as needed for visibility.

> Some gates or stands are not equipped with ground power. This is regular at smaller airports in Microsoft Flight Simulator. You can either call a Ground Power Unit (GPU) if available or
use the APU described in the upcoming steps.

## IRS
Prior to aligning the [IRS](), your PFD and MFD will look like ![this](). **This is normal behavior**, and indicates you have not aligned
the IRS, a system used to geolocate the aircraft's position. Align the IRS by rotating the RIGHT and LEFT knobs to `ON` position. It takes several minutes to
align [depending on your latitude]().

> To align the IRS instantly (not realistic) open the HEAVY menu in the FMC, select the IRS configuration option, and select the `FORCE ALIGN` option.


![]() <!-- GIF HERE -->
## APU
To supply enough power for engine start we need to start the APU. Turn the APU knob to the "START" position.

On the glareshield panel, ensure the APU is supplying power to the aircraft by selecting SYS on the EFIS panel, then on the MFD select the `STAT` tab.
If the EGT and voltage are rising, the APU is powering on and beginning to supply additional power to the aircraft. If the APU is not turning on, please refer to our [support guide]() for troubleshooting.
Once the RPM has reached 100% and the EGT rises to about 305 degrees Celsius, turn on `APU GEN` left and right.
> Note that the 787 Dreamliner features a 'no bleed' architecture. There is no need to supply the engines with bleed air from the APU or any external air power units, as the start sequence is handled entirely by electricity.

## Exterior Lighting
Set NAV and LOGO light switches to the `ON` position.

## Passenger Signs
Set the passenger seatbelt signs knob to the `ON` position.

> In the experimental version, `AUTO` is also supported.

> In real life, the seatbelt sign is not turned on until fueling is complete.

## Hydraulics
Ensure the C1, C2, L and R ELEC Hydraulic knobs are set to the `AUTO` position.

## Fuel
Ensure only the L PUMPS FWD switch is set to `ON`.

>The default 787 by Asobo includes a bug where engaging the left center fuel pump disables the APU. This is behavior is corrected in the experimental version only.

## Pedestal

## Radio Panel
Select the VHF menu and on the `L` row set the active frequency to **ATIS**, and the standby frequency to the **Ground** frequency.
Loading