Repository navigation
AUTHORING
This file defines the maintainer workflow for producing illustrated APT Wiki chapters from current application evidence and locally captured screenshots. It is not a substitute for checking the current source before writing a chapter.
For every chapter, use sources in this order:
- Current application behaviour and labels in
Scripts/gui/and the applicable adapter or analysis module. - The module's current
Docs/gui_help/<module>/README.md,glossary.md, andprocedure.mdwhere present. - Existing validated Wiki content.
Do not copy historical research conclusions into user instructions unless they remain part of current application behaviour. Do not invent controls, measurements, example values, compatibility, or safety claims.
- Wiki chapter: title case with hyphens, matching the displayed module name, for example
Battery-Pack-Management.mdorRange-Walk-Comparison.md. - Published image:
images/<module-slug>-<two-digit-order>-<subject>.png, for exampleimages/radio-link-01-bin-selection.png. - Screenshot input: use the same filename in
~/APT-Wiki-Screenshotsbefore publication when practical. - Use lowercase ASCII names, hyphens between words, a two-digit sequence, and
.pngunless another format is necessary. - Do not rename the two existing Battery images in the main APT repository. They are linked externally from the Battery chapter.
- Update the local APT source and open the current GUI.
- Capture only the screens needed for one chapter. Put the originals in
~/APT-Wiki-Screenshots. - Ask Codex to author one named module chapter. Codex must read the current GUI Help, glossary, procedure, GUI controls, adapter, and analysis presentation before drafting.
- Codex inspects every original at full resolution for usernames, home-directory paths, GPS coordinates, aircraft/site identifiers, serial numbers, filenames, dates, and other private data.
- If safe redaction is clear, Codex creates a publication copy under this repository's
images/directory. Crop only irrelevant application or desktop surroundings. Preserve control labels, evidence values, warnings, and analytical results. - If sensitive content cannot be confidently removed without changing evidence, stop and request a replacement screenshot. Do not publish the image.
- Codex writes the chapter using the structure below, adds it to
Home.mdand_Sidebar.mdonly when the chapter is ready, and verifies every Markdown link and local image path. - Review the rendered Markdown, image readability, and
git diff. Commit the chapter and images in a small Wiki commit. Push only after explicit approval.
Original screenshots remain outside Git in ~/APT-Wiki-Screenshots. Only reviewed publication copies belong in images/.
Each module chapter should contain:
# Module name- A concise purpose statement and supported input types.
## What you need-
## Run <module>with numbered steps using exact current button and field labels. - Screenshots immediately after the step or section they illustrate, with useful alt text and a short caption where context is needed.
-
## Read the reportexplaining the principal results and their provenance. -
## Limitationscovering missing evidence, scope, sampling, and safety qualifications. -
## Related informationlinking Home, related module chapters, in-app Help sources, and the applicable Test Procedure.
Where a module has multiple GUI pages or optional evidence, describe the normal path first and qualify optional paths separately. State when no BIN is required. Keep aircraft BIN evidence distinct from transmitter CSV evidence.
Make every embedded screenshot clickable so readers can open its full-resolution source. Use the same path or URL for the embedded image and its enclosing link:
[](images/module-slug-01-subject.png)Use repository-relative paths for Wiki-owned images so the Wiki clone can validate both the embedded image and full-resolution link locally. External images already published in the main APT repository may use stable raw GitHub URLs rather than being duplicated; use that same URL as the enclosing full-resolution link.
Before committing:
- Chapter controls and sequence match the current GUI.
- Inputs and outputs are identified by source and provenance.
- Missing data is described as unavailable, never inferred or converted to zero.
- Safety and evidence limitations from GUI Help remain intact.
- Screenshots contain no private paths, usernames, GPS coordinates, or unintended identifiers.
- Screenshots remain readable at normal Wiki width and analytical values are unaltered.
- All local image targets exist and all related chapter links resolve or are clearly marked forthcoming.
-
git status --shortcontains only the intended chapter, navigation, and reviewed images. - The commit is local until publication is explicitly approved.
Getting started
Battery & packs
Flight analysis
Radio & diagnostics
Reference