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

feat: takeoff performance documentation #986

Merged
merged 18 commits into from
Jun 30, 2024

Conversation

Valastiri
Copy link
Member

@Valastiri Valastiri commented Jun 28, 2024

Summary

In support of A32NX PR

Utilizes doc from @donstim with populated data.

Beginner Guide - Preparing MCDU has been altered to accommodate loss of auto LSK for vspeeds due to upcoming PR + Perf Calc

New Inclusions

  • Adds a convenience marketing redirect for easy access/posting. docs.flybywiresim.com/flypad-performance/
  • FEAT: Adds mathjax.js to support equations for the future and this PR.

Notes

I have split the pages into the general flypadOS 3 performance page AND a new advanced guide detailing how to use the calculator appropriately.

The EFB performance page has what the calculator is capable of and details on what each field is used for.

I'm not sure if we should include the entire example provided by Don on the EFB performance page or not. I have a use case to add this as an admonition with the entirety of the content and remove the advanced guides page.

TODO

  • Add media
  • Spruce up media
  • Organization
  • Add rest of content from doc
  • Utilize mkdocs material formula features

Location

  • docs/fbw-a32nx/feature-guides/flypados3/performance.md
  • docs/pilots-corner/advanced-guides/flight-planning/takeoff-perf-calc.md

Discord username (if different from GitHub): valastiri

@Valastiri Valastiri added the waiting on a32nx PR PRs waiting for the corresponding a32nx repo PR to be merged label Jun 28, 2024
Copy link

vercel bot commented Jun 28, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jun 30, 2024 1:42pm

@github-actions github-actions bot added advanced guides repo Changes to Repo or Config labels Jun 29, 2024
@Valastiri Valastiri marked this pull request as ready for review June 29, 2024 07:13
@github-actions github-actions bot added the Review Required PR Check Label label Jun 29, 2024
Copy link
Member

@alepouna alepouna left a comment

Choose a reason for hiding this comment

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

Leaving some comments. For the 10-9A remarks on the performance.md I feel like after one mention its enough, but perhaps alternatively we could add some 'on hover' mention of the 10-9A (or just reference it once as is), this is up to you - please note to not ignore the mention in takeoff-perf-calc.md regardless of previous choice

alepouna review

Co-authored-by: alepouna <[email protected]>
Copy link
Collaborator

@Sleinmaster Sleinmaster left a comment

Choose a reason for hiding this comment

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

First part of the Review, will check the advanced guide next.

docs/fbw-a32nx/feature-guides/flypados3/performance.md Outdated Show resolved Hide resolved
docs/fbw-a32nx/feature-guides/flypados3/performance.md Outdated Show resolved Hide resolved
docs/fbw-a32nx/feature-guides/flypados3/performance.md Outdated Show resolved Hide resolved
docs/fbw-a32nx/feature-guides/flypados3/performance.md Outdated Show resolved Hide resolved
docs/fbw-a32nx/feature-guides/flypados3/performance.md Outdated Show resolved Hide resolved
docs/fbw-a32nx/feature-guides/flypados3/performance.md Outdated Show resolved Hide resolved
docs/fbw-a32nx/feature-guides/flypados3/performance.md Outdated Show resolved Hide resolved
docs/fbw-a32nx/feature-guides/flypados3/performance.md Outdated Show resolved Hide resolved
docs/fbw-a32nx/feature-guides/flypados3/performance.md Outdated Show resolved Hide resolved
docs/fbw-a32nx/feature-guides/flypados3/performance.md Outdated Show resolved Hide resolved
@donstim donstim removed the waiting on a32nx PR PRs waiting for the corresponding a32nx repo PR to be merged label Jun 29, 2024
@donstim
Copy link

donstim commented Jun 29, 2024

Should remove the waiting on a32nx pr label

Copy link

@donstim donstim left a comment

Choose a reason for hiding this comment

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

Otherwise all suggested edits LGTM


**Runway Bearing**

- This is the magnetic direction of the runway. It will be entered automatically after entering the runway number.
Copy link

Choose a reason for hiding this comment

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

Suggested change: Replace "This is the magnetic direction of the runway" with "This is the direction of the runway with respect to magnetic North" (or "referenced to magnetic North") or similar.

Copy link
Member Author

Choose a reason for hiding this comment

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

modified Slein's suggest to accommodate the 2nd option here.

Copy link

Strict Build Failed! ❌ - Please checkout this PR locally to fix the issue before merging or see checks.

@github-actions github-actions bot added Review Required PR Check Label and removed Approved labels Jun 30, 2024
@github-actions github-actions bot removed the Review Required PR Check Label label Jun 30, 2024
@github-actions github-actions bot merged commit 27c6437 into flybywiresim:primary Jun 30, 2024
6 of 7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants