User guide in docs/guide, shown in the app under Help

- 16 Markdown pages covering every area for pilots, owners, mechanics
  and admins, readable on GitHub
- /help renders them with a page list; links between pages work in both
  places; only listed pages can be opened
- The electronic records instructions (AC 120-78B user instructions) are
  now the guide's records page, also used as the procedures appendix
- Help link in the main menu

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This commit is contained in:
rickyandClaude Opus 5.5 committed 2026-11-07 13:40:09 -05:00
1 parent 761f381679
commit fe3fba1736
28 files changed
+599 -32

No files matched your search

+41
View File
@@ -0,0 +1,41 @@
# Getting started
## Signing in
Depending on how the app is set up, you can sign in with:
- **Email and password.** Your administrator creates your account. Use **Forgot password?** to reset it if email is set up; otherwise ask the administrator.
- **Email me a sign-in link.** Enter your email and use the link sent to you. It works once, for a short time.
- **Single sign-on** (for example *Sign in with Authentik*), if your organization uses it.
The very first visit to a new installation asks for the administrator account instead.
## Roles
What you can do depends on your role on each aircraft:
| | Pilot | Owner | Admin |
|---|:-:|:-:|:-:|
| See everything on the aircraft | ✓ | ✓ | ✓ |
| Log flights, update hours, report squawks, add notes, oil and fuel | ✓ | ✓ | ✓ |
| Defer a squawk as inoperative | ✓ | ✓ | ✓ |
| Sign logbook entries (with your own certificate) | ✓ | ✓ | ✓ |
| Edit squawks and notes, resolve squawks | | ✓ | ✓ |
| Components, logbook, inspections, ADs, documents, major records, W&B | | ✓ | ✓ |
| Edit the aircraft, manage people and share links | | ✓ | ✓ |
| Users, settings, procedures and audits for the whole app | | | ✓ |
Anyone can add an aircraft and becomes its owner. You only see aircraft you have a role on; admins see all of them.
## Finding your way around
- **Fleet** (top left) lists your aircraft with their airworthiness.
- Each aircraft has tabs: **Overview, Components, Squawks, Flights, Oil & Fuel, Oil Analysis, Logbook, Inspections, ADs, Documents, Major Records, W&B, Notes, Activity**, and for owners **Access & Sharing**.
- **Log Flight** and **Report Squawk** are at the top of every aircraft page.
- Your name (or ☰ on a phone) leads to your **Profile**, this **Help**, and for admins the **Admin** pages.
## On a phone
The app works on phones. The tabs collapse into a **Section** menu, and wide tables scroll sideways. You can install it like an app: in Safari use **Share → Add to Home Screen**, in Chrome **Install app**.
The sun/moon button switches between light and dark themes.