Skip to content

Genericise the review into a vendor- and project-neutral technical reference - #33

Merged
dieterolson merged 2 commits into
mainfrom
docs/genericise-launch-monitor-reference
Aug 3, 2026
Merged

Genericise the review into a vendor- and project-neutral technical reference#33
dieterolson merged 2 commits into
mainfrom
docs/genericise-launch-monitor-reference

Conversation

@dieterolson

Copy link
Copy Markdown
Contributor

Removes the OpenFlight-specific framing so the document stands as a general technical reference on how launch monitors work — usable by anyone building or evaluating one. The technical content is unchanged; what changes is who the document addresses.

Structural

Was Now
"A technical foundation for the OpenFlight open-source launch monitor" "A comprehensive technical reference"
Callout box: "Implication for OpenFlight" (10 uses) "Design implication"
Ch. 10 "Implications for OpenFlight" — a project roadmap keyed to one parts list Ch. 10 "Design Guidance for Implementers" — four cumulative capability tiers, each defined by what it moves from derived to measured
App. B "Detailed Implementation Guidance for OpenFlight" "Detailed Implementation Guidance"
App. C "OpenFlight's actual and planned building blocks" A reference on commodity sensing components, explicitly representative rather than prescriptive
ofblue / ofgreen, header "OpenFlight Technology Review" accentblue / accentgreen, header "Launch Monitor Technology"

10-openflight-implications.tex10-design-guidance.tex. Roughly 20 first-person-project prose references rewritten to address "an implementer", "a radar-first system", or "a new entrant".

Two additions, not just deletions

An explicit neutrality statement in the introduction. The document names products constantly and often critically, and that needed explaining rather than hiding: vendor definitions, patent claims and measured tolerances are the primary evidence available in this field, because the peer-reviewed literature is thin (Ch. 9 documents exactly how thin). Naming a system is a citation, not a recommendation.

Reporting honesty as a design feature now closes Ch. 10. The independent validation evidence punishes derived quantities — clubhead velocity met research-grade tolerance on 54% and 29% of shots for the only two devices ever tested against a traceable benchmark, and club orientation data was returned on just 62% of shots overall, 19% for a wedge. None of that appears on a spec sheet. Garmin and TrackMan both publish provenance and reference-point disclosures without commercial harm, which makes it the closest thing to an adoptable standard.

Deliberately kept

OpenFlight and PiTrac stay in the commercial survey's open-source section, and their links stay in the reference appendix. Cataloguing them alongside TrackMan and Foresight is precisely what a neutral survey should do — removing them would make the survey less complete, not more neutral.

Guarding the change

CONVENTIONS.md gains a Neutrality section stating the rule for future edits: name a product only as evidence, write for "an implementer", and if a section can only be written by assuming one architecture, it belongs in Ch. 10 as a capability tier.

Verification

Full pdflatexbiberpdflatex ×2 build: zero undefined references, zero errors, TOC confirms Chapter 10 renamed.

⚠️ main.pdf is stale in this commit — it is file-locked by an open Acrobat window and could not be rewritten. Rebuild after closing the viewer.

🤖 Generated with Claude Code

Removes the OpenFlight-specific framing so the document stands as a general
technical reference on how launch monitors work, usable by anyone building or
evaluating one. The technical content is unchanged; what changes is who the
document addresses.

Structural changes:

- Retitled. Subtitle is now "A comprehensive technical reference"; the author
  field and the "technical foundation for OpenFlight" line are gone.
- The callout box that appears throughout was titled "Implication for
  OpenFlight" on all ten uses. It is now "Design implication" -- a consequence
  an implementer must act on, independent of any product.
- Chapter 10 rewritten from "Implications for OpenFlight" (a project roadmap
  keyed to one parts list) to "Design Guidance for Implementers", organised as
  four cumulative CAPABILITY TIERS defined by what each moves from derived to
  measured. File renamed 10-openflight-implications.tex -> 10-design-guidance.tex.
- Appendix B: "Detailed Implementation Guidance for OpenFlight" -> "Detailed
  Implementation Guidance".
- Appendix C reframed from "OpenFlight's actual and planned building blocks" to
  a reference on commodity sensing components, explicitly representative rather
  than prescriptive.
- Theme colours ofblue/ofgreen renamed accentblue/accentgreen; running header
  now "Launch Monitor Technology".

Prose: ~20 first-person-project references rewritten to address "an
implementer", "a radar-first system", or "a new entrant" as appropriate.

Two additions rather than deletions:

- The introduction gains an explicit neutrality statement, because the document
  names products constantly and often critically. Naming a system is a
  citation, not a recommendation -- and the reason products are cited so
  heavily is that vendor definitions, patent claims and measured tolerances are
  the primary evidence available here, the peer-reviewed literature being thin.
- Chapter 10's closing section now argues reporting honesty as a design
  feature, noting that Garmin and TrackMan both publish provenance and
  reference-point disclosures without commercial harm.

Deliberately KEPT: OpenFlight and PiTrac in the commercial survey's
open-source section, and their links in the reference appendix. Catalogueing
them alongside TrackMan and Foresight is what a neutral survey should do.

CONVENTIONS.md gains a Neutrality section stating the rule for future edits:
name a product only as evidence, write for "an implementer", and if a section
can only be written by assuming one architecture it belongs in Chapter 10 as a
capability tier.

Verified with a full pdflatex/biber/pdflatex x2 build: zero undefined
references, zero errors, TOC confirms the renamed chapter.

NOTE: main.pdf is stale in this commit -- it is file-locked by an open Acrobat
window and could not be rewritten. Rebuild after closing the viewer.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: db48a79d71

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread tech-review/preamble.tex
Comment on lines +35 to +37
\definecolor{accentblue}{RGB}{20,60,110}
\definecolor{ofgray}{RGB}{90,95,100}
\definecolor{accentgreen}{RGB}{25,110,60}

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P1 Badge Update the remaining users of the renamed colors

Renaming these definitions removes ofblue and ofgreen, but the D-plane TikZ figure in sections/03-impact-physics.tex still uses those names on lines 41 and 44. Building the document therefore raises an xcolor “Undefined color” error, and the checked tech-review.yml workflow runs LaTeX with -halt-on-error, so every CI build of this commit fails. Update the figure or retain aliases for the old names.

Useful? React with 👍 / 👎.

Comment thread tech-review/main.tex
Comment on lines +5 to +7
\Large Measurement Principles, Patent Landscape, and Club/Ball Parameter Estimation\\[6pt]
\large A comprehensive technical reference}
\author{}

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P2 Badge Regenerate the checked-in PDF with the neutralized source

The repository directs readers to main.pdf as the compiled report, but this commit leaves that PDF byte-for-byte identical to the parent while changing the title, author, date, and Chapter 10 source. Readers opening the tracked artifact therefore still receive the old OpenFlight-specific edition rather than the vendor-neutral document described by the updated README.

Useful? React with 👍 / 👎.

Comment on lines +108 to +110
\cref{ch:flight} shows that a coefficient difference of 0.01 in $C_D$ is
worth roughly eight yards, so an unversioned model change is a silent
recalibration of every number the device has ever reported.

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P2 Badge Substantiate or remove the eight-yard drag claim

The cited ch:flight chapter defines aerodynamic models and coefficient values but never presents this 0.01 sensitivity or an eight-yard result; a repository-wide search also finds this quantified claim only here. As written, the technical reference tells readers that another chapter demonstrates a result that is absent, so add the calculation/source supporting the stated sensitivity or avoid the number.

Useful? React with 👍 / 👎.

The previous commit renamed ofblue/ofgreen to accentblue/accentgreen in
preamble.tex but left ofgray undefined-by-omission and, more importantly, left
the TikZ figures in sections/*.tex still referencing the old names. An
undefined colour only errors where it is USED, so the failure surfaced in
03-impact-physics.tex, a chapter away from the file I edited.

Renames all three consistently across preamble.tex and every section file:
ofblue -> accentblue, ofgreen -> accentgreen, ofgray -> accentgray. No stale
of* colour references remain.

My local verification missed this because I ran pdflatex WITHOUT
-halt-on-error and then grepped the log for error strings. Without that flag
pdflatex recovers from a fatal error, continues, and still emits a PDF -- so the
grep came back clean on a build CI correctly rejected. Rebuilt with CI's flags
and checked the exit code: pass 1 exit 0, final exit 0, zero fatal errors, zero
undefined references.

CONVENTIONS.md gains that lesson, plus the two failure modes behind it: that an
undefined colour or macro surfaces at its use site rather than its definition
site, and that on Windows an open PDF viewer file-locks main.pdf and leaves a
stale artefact -- build with -jobname=verify to check around it.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@dieterolson
dieterolson merged commit b5c284f into main Aug 3, 2026
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant