Disclaimer about router terminology on node-roles-and-types.md#160
Disclaimer about router terminology on node-roles-and-types.md#160rochaferraz wants to merge 1 commit intoopenthread:mainfrom
Conversation
Routers are now officially named "Thread Mesh Extenders" on all consumer facing comms. Adding this information here. Q: should we update *all* documentation to reflect the name change or can we still use "router" in engineering docs and primers?
|
Sorry, I missed this. @jwhui is this a change we should make in the OpenThread docs? |
Yes, we should put something to this effect. "Mesh Extenders" is the name Thread Group recommends for consumer-facing documentation. But "Routers" is still used by the Thread Specification. |
|
Yeah I would just change it a few places for now, these docs are not really for consumers. I haven't looked at the Primer material in a while, I'll have to see other places where it makes sense to change and also mention Mesh Extenders. |
|
@Vyrastas Currently the term "Router" is still used in Thread 1.4.x specifications. Change of the term is pending for a future spec update, but is not the highest priority. |
|
/gemini review |
There was a problem hiding this comment.
Pull Request Overview
This PR adds a disclaimer to clarify the terminology change from "Router" to "Thread Mesh Extender" for consumer-facing communications while maintaining technical documentation consistency.
- Updates the section header to include both "Router" and "Thread Mesh Extender" terminology
- Adds a disclaimer explaining the preferred consumer-facing terminology
- Clarifies that technical documentation may continue using "Router"
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
| * provides secure commissioning services for devices trying to join the network | ||
| * keeps its transceiver enabled at all times | ||
|
|
||
| Routers must be denominated "Thread Mesh Extenders" for all consumer-facing communications, |
There was a problem hiding this comment.
The word 'denominated' is incorrect in this context. Consider using 'called', 'named', or 'referred to as' instead.
| Routers must be denominated "Thread Mesh Extenders" for all consumer-facing communications, | |
| Routers must be called "Thread Mesh Extenders" for all consumer-facing communications, |
There was a problem hiding this comment.
Code Review
This pull request adds a disclaimer to clarify the terminology for Thread Routers, which are now officially called 'Thread Mesh Extenders' in consumer-facing materials. The change correctly updates the relevant documentation page to inform readers about both terms. This approach of adding a note instead of replacing all instances of 'Router' seems sensible for technical documentation. My review includes a minor suggestion to improve the wording of the new disclaimer for better readability. Please also consider updating the corresponding Chinese documentation file (site/zh-cn/guides/thread-primer/node-roles-and-types.md) to maintain consistency between language versions.
| Routers must be denominated "Thread Mesh Extenders" for all consumer-facing communications, | ||
| but documentation and technical publications might also use the legacy "Router" terminology. |
There was a problem hiding this comment.
For improved readability, you could rephrase this note. The word 'denominated' is quite formal, and the sentence can be made more direct and clear.
| Routers must be denominated "Thread Mesh Extenders" for all consumer-facing communications, | |
| but documentation and technical publications might also use the legacy "Router" terminology. | |
| For consumer-facing communications, Routers are officially called "Thread Mesh Extenders". However, technical documentation like this guide may continue to use the legacy term "Router". |
|
Just a review comment on this: per https://threadgroup.atlassian.net/browse/SPEC-1288 , the term "Router" would be updated to "Mesh Extender" (and not "Thread Mesh Extender"). |
Vyrastas
left a comment
There was a problem hiding this comment.
Can approve once the AI/bot comments are addressed
And my comment, hopefully! Although phrased as a question, I proposed a change in the terminology, to keep consistency. I.e. use the term "Mesh Extender" instead of "Router". |
Routers are now officially named "Thread Mesh Extenders" on all consumer facing comms. Adding this information here.
Q: should we update all documentation to reflect the name change or can we still use "router" in engineering docs and primers?