Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Document TTS countdown + bridge toggle in user manual#71

Merged
Saqoosha merged 1 commit into
developfrom
docs/manual-tts-countdown
May 18, 2026
Merged

Document TTS countdown + bridge toggle in user manual#71
Saqoosha merged 1 commit into
developfrom
docs/manual-tts-countdown

Conversation

@Saqoosha

@Saqoosha Saqoosha commented May 18, 2026

Copy link
Copy Markdown
Owner

Summary

Catches the user manual up with the two visible Settings surfaces added in 1.0.1.

App → Lap announcer (Audio)

  • New Count down final seconds toggle (off by default) + Start at stepper (5–15 s, default 10) for the spoken countdown ("ten, nine, ..." / "じゅう、きゅう...").
  • The automatic "Last lap!" / "ファイナルラップです" cue at remaining = 0 is now mentioned on the existing Announce lap times entry — it fires whenever lap-time announcements are on, independent of the countdown toggle.

Device → Use bridge

  • New H3 above the existing M5StickS3 (Connection) entry, documenting the master switch that gates the M5StickS3 / Goggle pairing / OSD layout drilldowns.
  • Off by default on fresh installs (no Bluetooth permission prompt for users who don't own a bridge). Existing users with prior goggle pairings keep it on after upgrading.
  • The three drilldown entries now note "Only visible when Use bridge is on" so the doc matches what users actually see in Settings.

Both updates mirrored in en.md and ja.md. No source changes — this is documentation only.

Test plan

  • Render the manual (locally or via the deployed Pages preview at https://saqoosha.github.io/HDZap/dev/) and verify the Settings reference reads top-to-bottom in the same order as the in-app Settings screen.
  • Confirm both languages stay in sync — the bullet structure, the labels, and the "only visible when …" notes appear in both en.md and ja.md.
  • Cross-check Section 5 references still resolve (the existing rename-M5StickS3 anchor still works because that section wasn't touched).

Summary by CodeRabbit

Documentation

  • ユーザーマニュアルを更新しました
    • Bluetoothペアリング手順に「ブリッジを使う」機能の設定ガイドを追加
    • デバイス設定リファレンスで「ブリッジを使う」トグルの動作と初期動作を詳細化
    • ラップ読み上げ設定に最終区間のカウントダウン機能と開始秒数設定を追記

Review Change Stack

@coderabbitai

coderabbitai Bot commented May 18, 2026

Copy link
Copy Markdown

Caution

Review failed

Pull request was closed or merged during review

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 52cd78f4-a167-4dfa-ad66-f868da31a7cd

📥 Commits

Reviewing files that changed from the base of the PR and between 4bbec4f and 9bcb995.

📒 Files selected for processing (2)
  • docs/manual/en.md
  • docs/manual/ja.md

Walkthrough

ユーザーマニュアルをBluetooth接続設定の「Use bridge」トグル機能に対応させ、デバイス設定リファレンスに新たに「ブリッジを使う」セクションを追加。ラップ読み上げ設定にもカウントダウン機能と開始秒数オプションの説明を追加し、英語・日本語両版を並行更新。

Changes

設定機能ドキュメント化更新

Layer / File(s) Summary
Bluetooth ペアリングと Use bridge トグル
docs/manual/en.md (181–186), docs/manual/ja.md (181–186)
iPhone と M5StickS3 の Bluetooth ペアリング手順に、Settings 内の「Use bridge」をオンにする作業を追加し、オンになるまで関連行が非表示となること、初回ON時にBluetooth利用許可プロンプトが表示される点を両言語で明記。
デバイス設定リファレンス:ブリッジ接続
docs/manual/en.md (479–487), docs/manual/ja.md (481–489)
Settings reference に「デバイス → ブリッジを使う」セクションを新設し、初期値OFF・ON時の3項目表示(M5StickS3 / ゴーグルペアリング / OSD レイアウト)、既存ユーザの引き継ぎ挙動、M5StickS3(接続)の表示条件を両言語で説明。
ラップ読み上げカウントダウン設定
docs/manual/en.md (515–519), docs/manual/ja.md (517–521)
「アプリ → ラップ読み上げ」設定項目を拡張し、ファイナルラップ・ベストラップ読み上げ、最終秒カウントダウン(既定OFF)、開始秒数(既定10秒)の条件・既定値・表示制御を両言語で追記。

🎯 2 (Simple) | ⏱️ ~8 minutes

ドキュメント更新でブリッジ機能を説明し、
ラップのカウントダウンも加わった。
設定リファレンス整えて、ユーザーへの案内も🐰✨

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed タイトルは、プルリクエストの主な変更点である「TTS カウントダウン機能」と「ブリッジトグル」の2つの機能をユーザーマニュアルに文書化することを明確に示しており、変更セットの主要な目的を正確に要約しています。
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/manual-tts-countdown

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Catches the manual up with the 1.0.1 features that have visible
Settings surfaces, plus the workflow change they imply:

- **Section 5 — Pairing the M5StickS3**: new step 3 telling first-time
  users to flip **Use bridge** on before drilling into the M5StickS3
  row (it's hidden on a fresh install until the toggle goes on).
- **Section 10 — App → Lap announcer (Audio)**: new "Count down final
  seconds" toggle + "Start at" stepper (5–15 s, default 10) for the
  spoken countdown ("ten, nine, ..." / "じゅう、きゅう...").
  The automatic "Last lap!" / "ファイナルラップです" cue at
  remaining = 0 is noted on the existing "Announce lap times" entry.
- **Section 10 — Device → Use bridge**: new H3 above the existing
  M5StickS3 entry, documenting the master switch that gates the
  M5StickS3 / Goggle pairing / OSD layout drilldowns. Off by default
  on fresh installs (no Bluetooth permission prompt for users who
  don't own a bridge); existing users keep it on after upgrading.
- The three drilldown entries (M5StickS3, Goggle pairing, OSD layout)
  now note "Only visible when **Use bridge** is on" so the doc lines
  up with what users actually see in Settings.

Mirrored in en.md and ja.md.

Co-Authored-By: Claude Opus 4.7 <[email protected]>
@Saqoosha Saqoosha force-pushed the docs/manual-tts-countdown branch from 02a522b to 9bcb995 Compare May 18, 2026 12:37
@Saqoosha Saqoosha merged commit de08a54 into develop May 18, 2026
2 of 3 checks passed
@Saqoosha Saqoosha deleted the docs/manual-tts-countdown branch May 18, 2026 12:39
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