Skip to content

fix(docs): Update DOCS.md with Thread creds sync instructions #4428

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
tyeth wants to merge 1 commit into
base: master
Choose a base branch
from
Draft

fix(docs): Update DOCS.md with Thread creds sync instructions #4428

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions openthread_border_router/DOCS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,19 @@ create a new integration named "Open Thread Border Router". With Home Assistant
Core 2023.3 and newer the OTBR will get configured automatically. The Thread
integration allows to inspect the network configuration.

You will still need to go to the Thread settings page and select your preferred
network, choose the option for **Use router for Android and iOS credentials**,
and then you can add devices using your mobile via the Home-Assistant companion
app. **Don't forget to sync the credentials** for the Thread network with your
companion app.
Comment on lines +49 to +53
Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai bot Feb 16, 2026

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor

Make the instruction direct and goal‑fronted.
Current phrasing is indirect (“You will still need…”, “you can…”). Use a direct instruction and front the goal; keep UI strings bold.

✅ Proposed rewrite 
-You will still need to go to the Thread settings page and select your preferred
-network, choose the option for **Use router for Android and iOS credentials**, 
-and then you can add devices using your mobile via the Home-Assistant companion
-app. **Don't forget to sync the credentials** for the Thread network with your
-companion app.
+Select the Thread network and enable **Use router for Android and iOS credentials**.
+Add devices in the Home Assistant Companion app after you sync Thread credentials.
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
You will still need to go to the Thread settings page and select your preferred
network, choose the option for **Use router for Android and iOS credentials**,
and then you can add devices using your mobile via the Home-Assistant companion
app. **Don't forget to sync the credentials** for the Thread network with your
companion app.
Select the Thread network and enable **Use router for Android and iOS credentials**.
Add devices in the Home Assistant Companion app after you sync Thread credentials.
🤖 Prompt for AI Agents 
Before applying any fix, first verify the finding against the current code and
decide whether a code change is actually needed. If the finding is not valid or
no change is required, do not modify code for that item and briefly explain why
it was skipped.
In `@openthread_border_router/DOCS.md` around lines 49 - 53, Rewrite the paragraph
to be a direct, imperative instruction that fronts the goal (adding devices via
mobile) while keeping UI strings bold; specifically change the indirect
sentences around the **Use router for Android and iOS credentials** option and
the Home-Assistant companion app into commands (e.g., "Select your preferred
network in Thread settings, enable **Use router for Android and iOS
credentials**, then add devices from the Home-Assistant companion app and sync
the Thread credentials."), and preserve the bold UI text and the reminder to
sync credentials.


On an Android phone in the HA app go to **Settings** > **Companion App** >
**Troubleshooting** > **Sync Thread credentials**.

Or for an iPhone, go to **Settings** > **Devices & services**, select the
Thread integration, select **Configure** under Services. At the bottom of the
preferred network box, select **Send credentials to phone**.
Comment on lines +55 to +60
Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai bot Feb 16, 2026

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor

Front the goal in the step instructions.
These steps start with location (“On an Android phone…”) instead of the goal. Rephrase to goal‑fronted instructions.

✅ Proposed rewrite 
-On an Android phone in the HA app go to **Settings** > **Companion App** >
-**Troubleshooting** > **Sync Thread credentials**.
+Sync Thread credentials on Android: In the Home Assistant app, go to
+**Settings** > **Companion App** > **Troubleshooting** > **Sync Thread credentials**.
 
-Or for an iPhone, go to **Settings** > **Devices & services**, select the
-Thread integration, select **Configure** under Services. At the bottom of the
-preferred network box, select **Send credentials to phone**.
+Send Thread credentials to iPhone: In the Home Assistant app, go to **Settings**
+> **Devices & services** > **Thread** > **Configure**, then select **Send credentials to phone**.
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
On an Android phone in the HA app go to **Settings** > **Companion App** >
**Troubleshooting** > **Sync Thread credentials**.
Or for an iPhone, go to **Settings** > **Devices & services**, select the
Thread integration, select **Configure** under Services. At the bottom of the
preferred network box, select **Send credentials to phone**.
Sync Thread credentials on Android: In the Home Assistant app, go to
**Settings** > **Companion App** > **Troubleshooting** > **Sync Thread credentials**.
Send Thread credentials to iPhone: In the Home Assistant app, go to **Settings**
> **Devices & services** > **Thread** > **Configure**, then select **Send credentials to phone**.
🤖 Prompt for AI Agents 
Before applying any fix, first verify the finding against the current code and
decide whether a code change is actually needed. If the finding is not valid or
no change is required, do not modify code for that item and briefly explain why
it was skipped.
In `@openthread_border_router/DOCS.md` around lines 55 - 60, Reword the two steps
to be goal‑first by leading with the action (e.g., "Send/sync Thread credentials
to your phone") then follow with concise platform-specific steps; for Android,
start with the goal then "On the HA app go to Settings > Companion App >
Troubleshooting > Sync Thread credentials"; for iPhone, start with the goal then
"In the HA app go to Settings > Devices & services, select the Thread
integration, Configure under Services, and tap 'Send credentials to phone' at
the bottom of the preferred network box"; ensure the exact phrases "Sync Thread
credentials" and "Send credentials to phone" remain intact for discoverability.


### Web interface (advanced)

There is also a web interface provided by the OTBR. However, the web
Expand Down