Skip to content

Doku: DeviceTester index.md vollständig überarbeitet#3

Merged
peterus merged 3 commits into
mainfrom
docs/improve-index
May 13, 2026
Merged

Doku: DeviceTester index.md vollständig überarbeitet#3
peterus merged 3 commits into
mainfrom
docs/improve-index

Conversation

@peterus

@peterus peterus commented May 13, 2026

Copy link
Copy Markdown
Member

Summary

Vollwertige Überarbeitung der DeviceTester-Doku im selben Stil wie die anderen vier Module:

  • 1-Satz Description (SEO + Side-Nav)
  • Übersicht — Zwei-Seiten-Architektur (Device-Tester male / Bus-Tester female), drei Power-Rails, Flash-Header für CM4-rpiboot
  • Mermaid Block-Diagramm aller Verbindungen inkl. DUT-/BB-Einsteckpunkte
  • Steckverbinder-Tabelle: alle 7 J-Refs (Phoenix, 2× USB-C, 4-pin Flash J202, 2× PCN10 in entgegengesetzten Geschlechtern J203/J302, +5V_B-Enable J303)
  • Versorgung-Tabelle für +12V / +5V_A / +5V_B mit Status-LEDs (D101/D201/D301)
  • CM4-Flash-Sektion mit J202-Pinout und exakter Jumper-Konfiguration (Pin 1↔2 für nRPIBOOT auf GND, Pin 3↔4 für USB_OTG_ID auf +5V_A) + 5-Step-Workflow inkl. „Jumper nach Flashen abziehen"-Warnung
  • 3 dokumentierte Test-Workflows (DUT-Standalone-Test, CM4-Flash, BusBoard-Test ohne PowerBoard)
  • DeviceTester-eigene Bringup-Checkliste inkl. J303-Isolations-Test
  • Cross-Links zu allen 4 verwandten Modulen

Test plan

  • 8× site.data.project.name, keine stray main- refs, kein Unicode-Minus
  • kibot-check passes on PR
  • Post-merge debug-docs runs and gh-pages updates

Copilot AI review requested due to automatic review settings May 13, 2026 19:31
Adds:
- 1-sentence description front-matter
- Übersicht: two-sided board (Device-Tester male PCN10 / Bus-Tester
  female PCN10C) + 3 power rails + flash header for rpiboot
- Mermaid block diagram showing both halves + flash header + DUT/BB
- Steckverbinder-Tabelle: all 7 J-refs (Phoenix, 2× USB-C, 4-pin Flash,
  2× PCN10 in opposite genders, 2-pin +5V_B-Enable)
- Versorgung-Tabelle (+12V, +5V_A, +5V_B with their LED indicators)
- CM4 flashen: J202 pinout + jumper combos (1↔2 nRPIBOOT, 3↔4
  USB_OTG_ID) + 5-step rpiboot workflow with cleanup reminder
- Three test workflows:
  1. DUT standalone bring-up
  2. CM4 flash (rpiboot)
  3. BusBoard test ohne PowerBoard (with J303 jumper)
- Bringup checklist for the DeviceTester itself, incl. J303 isolation test
- Verwandte Module cross-links

Source-of-truth: pinouts and footprints extracted via
`kicad-cli sch export netlist` + PCB footprint scan.

Copilot AI 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.

Pull request overview

Überarbeitet die DeviceTester-Dokumentation umfassend und strukturiert sie im Stil der übrigen Hardware-Module, inkl. klarer Übersicht, Anschluss-/Versorgungstabellen, Flash-Anleitung (CM4/rpiboot) und praxisnahen Test-/Bring-up-Workflows.

Changes:

  • Ergänzt Frontmatter-description sowie eine neue, deutlich ausführlichere Übersichtssektion (2-Seiten-Konzept, Rails, Entkopplung).
  • Fügt Mermaid-Blockdiagramm, detaillierte Steckverbinder-/Versorgungstabellen und CM4-Flash-Pinout + Schrittfolge hinzu.
  • Dokumentiert Test-Workflows, Bring-up-Checkliste und Cross-Links zu verwandten Modulen.
Comments suppressed due to low confidence (1)

doc/index.md:110

  • Auch hier ist der Linktext mit gemischten Anführungszeichen geschrieben (öffnet mit „, schließt aber mit "). Bitte konsistent setzen.
Siehe Sektion [„CM4 flashen"](#cm4-flashen) oben.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread doc/index.md Outdated
Comment thread doc/index.md Outdated
- Replace mixed German opening + English closing quotes with consistent
  ASCII quotes throughout the doc (4 occurrences: L24 cross-link to
  CM4-Flash, L58 J203 description, L60 J302 description, L110 Test-
  Workflow Section 2 cross-link).

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

Copilot AI 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.

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated 1 comment.

Comment thread doc/index.md
- Normalize 'Bring-up' → 'Bringup' throughout (6 occurrences) for
  consistency with PowerBoard, BusBoard, CM4Carrier, and FM-Transceiver
  docs which all use the no-hyphen spelling.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

Copilot AI 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.

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated no new comments.

@peterus peterus merged commit 2080303 into main May 13, 2026
5 checks passed
@peterus peterus deleted the docs/improve-index branch May 13, 2026 19:47
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.

2 participants