Skip to content

docs(g6 dev): clean up stale (Open Question #N) references#54

Merged
mbreiser merged 1 commit into
mainfrom
docs/fix-stale-question-refs
May 24, 2026
Merged

docs(g6 dev): clean up stale (Open Question #N) references#54
mbreiser merged 1 commit into
mainfrom
docs/fix-stale-question-refs

Conversation

@mbreiser
Copy link
Copy Markdown
Contributor

Summary

Closes #51. Pure-docs cleanup: the "Open Questions" sections in g6_02 + g6_03 were renumbered/pruned during PR #53's restructure, but inline (Open Question #N) and (Open Q #N) parentheticals in the body weren't updated, leaving four dangling references.

Each is replaced with what the item actually resolved to — no content removed, only stale numbering pointers updated.

Changes

File:Line Before After
g6_02:85 board-id mechanism (Open Question #4) -DPANEL_REV build flag in panel/platformio.ini
g6_02:168 v0.2/v0.3 designators pending KiCad-source extraction (Open Question #2) verified identical to v0.1 — no separate CSV needed (per @mbreiser confirmation)
g6_02:243 sch_to_pos_index() ... (Open Q #5) now panel/src/layout.{h,cpp} per firmware commit 7c042cd
g6_03:61 Spec ↔ impl divergence D9 in g6_04 — three options to resolve three options inlined directly (D9 didn't exist in g6_04)

Test plan

  • Diff inspected; only the four references touched
  • No (Open Question / (Open Q parentheticals remain that reference numbers outside the current Q lists
  • Frank reviews and confirms the replacements match intent (esp. g6_03:61 inlining)

The "Open Questions" sections in g6_02 + g6_03 were renumbered/pruned
during PR #53's restructure, but inline `(Open Question #N)` and
`(Open Q #N)` parentheticals in the body were not updated, leaving
dangling references. Closes #51.

Four updates, all replace dangling refs with what the items actually
resolved to:

1. g6_02:85 board-id mechanism — was "(Open Question #4)" which no
   longer exists. Implementation is the build-time `-DPANEL_REV` flag
   in panel/platformio.ini (envs pico_v021, pico_v031). Replaced the
   parenthetical with a direct cite to that file.

2. g6_02:168 LED designators — was "(Open Question #2)" pending KiCad
   extraction. Per user verification: v0.2 and v0.3 designator tables
   are identical to v0.1; no separate CSV needed. Replaced the prose
   accordingly.

3. g6_02:243 schematic → physical pin remapping — was "(Open Q #5)"
   referencing iorodeo's display.cpp::sch_to_pos_index(). That has
   been replaced by panel/src/layout.{h,cpp} in
   LED-Display_G6_Firmware_Panel commit 7c042cd. Updated the cross-
   reference accordingly.

4. g6_03:61 panel-set ordering divergence — was "Spec ↔ impl
   divergence D9 in g6_04 — three options to resolve". D9 doesn't
   exist in g6_04. Inlined the three resolution options directly
   in the table cell; controller bring-up will pick one.

No content was removed; only stale numbering pointers were replaced
with what they actually pointed at. The current Open Questions
sections in g6_02 (2 items) and g6_03 are unchanged.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
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.

(cosmetics): Questions for current set of documents

1 participant