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

-21
View File
@@ -1,21 +0,0 @@
<%# User instructions for electronic records (also an appendix of the procedures document). %>
<div class="space-y-3 text-sm leading-relaxed">
<h3 class="font-semibold">Writing an entry</h3>
<p>On the aircraft's Logbook tab, choose <strong>+ New Entry</strong>. Give the date, the logbook (aircraft, engine, propeller), the airframe total time, and what was done; for an engine or propeller entry pick the component (its times fill in) and tick any sub-components. A template can start the wording. An entry isn't a signed record until it's signed.</p>
<h3 class="font-semibold">Signing</h3>
<ol class="list-decimal space-y-1 pl-5">
<li>Add your certificate (kind and number) once, on your profile.</li>
<li>Open the entry and choose <strong>Sign</strong>. Read the entry as shown: your signature covers exactly that.</li>
<li>Pick the certificate you're signing with. The statement you'll certify is shown with it (return to service, or the inspection statement).</li>
<li>Re-enter your password, or sign in again with single sign-on, tick the confirmation and choose <strong>Sign entry</strong>. You'll see a confirmation and get an email.</li>
</ol>
<p>Never share your password or let someone else sign while you're signed in: a signature is yours alone. If you think someone has, tell the administrator straight away.</p>
<h3 class="font-semibold">Mistakes</h3>
<p>A signed entry can't be edited or deleted. Open it and choose <strong>Correct this entry</strong>: a new entry starts from the original; fix it, save, and sign it. The original stays, marked “Superseded by a correction”.</p>
<h3 class="font-semibold">Someone else did the work</h3>
<p>The owner can choose <strong>Ask someone to sign</strong> on the entry: the mechanic gets a one-time email link, signs in or creates their own account, adds their certificate and signs. If they prefer paper, print the entry (<strong>Print for logbook</strong>), have it signed in ink, and keep the paper with the logbooks (scan it into Documents).</p>
<h3 class="font-semibold">Checking a record</h3>
<p>A signed entry shows who certified it, with which certificate, when (UTC), what they certified, and its status. <strong>Valid</strong> means nothing has changed since signing. The fingerprint (a SHA-256 of the entry) is printed on paper copies so a copy can be matched to the record. Every change to any record is kept under <strong>Activity → Record history</strong>.</p>
<h3 class="font-semibold">If the system is down</h3>
<p>Make the entry on paper and sign it in ink. When the system is back, add the entry and scan the signed paper into Documents; the paper itself stays with the logbooks and remains the signed record for that entry.</p>
</div>
-6
View File
@@ -1,6 +0,0 @@
<% content_for :title, "How electronic records work" %>
<section class="card card-body max-w-3xl">
<h1 class="text-2xl font-bold">How electronic records work</h1>
<p class="mb-4 mt-1 text-sm text-slate-600">Instructions for everyone who keeps or signs maintenance records here.</p>
<%= render "help/records_content" %>
</section>
+14
View File
@@ -0,0 +1,14 @@
<% content_for :title, "Help: #{@page.title}" %>
<div class="grid gap-5 lg:grid-cols-[14rem_1fr]">
<nav aria-label="Help pages" class="lg:order-none">
<details class="card lg:hidden">
<summary class="card-header cursor-pointer"><span class="card-title">Help: <%= @page.title %></span></summary>
<ul class="p-2 text-sm"><% @pages.each do |p| %><li><%= link_to p.title, help_page_url_for(p.slug), class: [ "block rounded px-3 py-2 hover:bg-slate-100", ("bg-slate-100 font-semibold text-sky-700" if p == @page) ] %></li><% end %></ul>
</details>
<ul class="sticky top-4 hidden space-y-0.5 text-sm lg:block">
<% @pages.each do |p| %><li><%= link_to p.title, help_page_url_for(p.slug), class: [ "block rounded px-3 py-1.5 hover:bg-slate-100", ("bg-slate-100 font-semibold text-sky-700" if p == @page) ],
aria: { current: (p == @page ? "page" : nil) } %></li><% end %>
</ul>
</nav>
<article class="card card-body min-w-0 max-w-3xl"><%= guide_html(@page) %></article>
</div>