docs: normalize product/tech name casing (nRF52840, ESP32-S3, LoRa, WiFi, Node-RED)#2540
docs: normalize product/tech name casing (nRF52840, ESP32-S3, LoRa, WiFi, Node-RED)#2540bruschill wants to merge 3 commits intomeshtastic:mastermeshtastic/meshtastic:masterfrom bruschill:docs/terminology-casingbruschill/meshtastic:docs/terminology-casingCopy head branch name to clipboard
Conversation
Consistency-only casing fixes toward official forms (no meaning changes), carefully scoped to prose to avoid clobbering product names, code, IDs, URLs, and file paths: - NRF52840 -> nRF52840 (10; Nordic's official casing, in device spec tables). - ESP32S3 -> ESP32-S3 (4; Espressif's official casing, matches dominant usage). - Wi-Fi -> WiFi (13; matches the docs' overwhelmingly dominant house style). - Lora -> LoRa (5; only genuine radio-technology references, NOT LILYGO product names like 'T-Lora' / 'TTGO Lora' / 'Lora V2.1', which are left as-is). - Node-red / node-red -> Node-RED (2). Deliberately NOT touched: the Elecrow wiki URL containing NRF52840, LILYGO 'T-Lora'/'TTGO Lora' board names, 'gateway-wifi' JSX values, lowercase 'nrf52840' tab/CLI identifiers, and the meshtasticd/MeshtasticD casing (the project brands its own page title 'MeshtasticD' and the name appears in image file paths, so that normalization is left for maintainers).
|
@bruschill is attempting to deploy a commit to the Meshtastic Team on Vercel. A member of the Team first needs to authorize it. |
🤖 Docs ReviewHey @bruschill! Thanks for the docs contribution! Here's a quick review: A few things to check: 🔗 docs/hardware/devices/seeed-studio/sensecap/indicator.mdx — Looks like this uses a relative import path. Could you use the No rush — just some things that would help keep the docs consistent. Let me know if you have any questions! This is an automated review based on docs contribution guidelines. |
📝 WalkthroughWalkthroughDocumentation-only edits normalize terminology and capitalization for WiFi, LoRa, nRF52840, ESP32-S3, and Node-RED across overview, hardware, software, integration, and glossary pages. ChangesDocumentation terminology normalization
Estimated code review effort: 1 (Trivial) | ~5 minutes Suggested reviewers: Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
Warning Tools execution failed with the following error: Failed to run tools: 14 UNAVAILABLE: read ECONNRESET 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. Comment |
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs/hardware/devices/b-and-q-consulting/nano/index.mdx`:
- Line 30: Update the changed Nano G2 Ultra sentence to hyphenate “low-power”
when it modifies “MCU,” while leaving the surrounding hardware description
unchanged.
In `@docs/hardware/devices/seeed-studio/sensecap/indicator.mdx`:
- Line 12: Revise the introductory sentence so the 4-inch touchscreen device is
the grammatical subject of “supports,” while retaining the existing MCU and
connectivity details.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro Plus
Run ID: 10726147-d212-44fc-b3f8-f54b22a9001c
📒 Files selected for processing (22)
docs/about/overview/encryption/index.mdxdocs/about/overview/index.mdxdocs/configuration/module/mqtt.mdxdocs/hardware/devices/b-and-q-consulting/index.mdxdocs/hardware/devices/b-and-q-consulting/nano/index.mdxdocs/hardware/devices/community-supported/b-and-q-consulting/nano/index.mdxdocs/hardware/devices/community-supported/canary/index.mdxdocs/hardware/devices/community-supported/index.mdxdocs/hardware/devices/community-supported/seeed-studio/wio-series/wio-sx1262.mdxdocs/hardware/devices/elecrow/index.mdxdocs/hardware/devices/elecrow/thinknode/index.mdxdocs/hardware/devices/index.mdxdocs/hardware/devices/seeed-studio/sensecap/indicator.mdxdocs/hardware/devices/seeed-studio/wio-series/wio-sx1262.mdxdocs/software/apple/developer/transport.mddocs/software/apple/user/mqtt.mddocs/software/apple/user/settings.mddocs/software/apple/user/signal-meter.mddocs/software/apple/user/watch.mddocs/software/integrations/mqtt/index.mdxdocs/software/integrations/mqtt/nodered.mdxdocs/terms/index.mdx
- nano/index.mdx: hyphenate 'low-power MCU' (compound adjective). - sensecap/indicator.mdx: rephrase the intro sentence so the device is the subject of 'supports' (was a dangling 'device, ... and supports'). Both are on lines already modified by the casing sweep. (CodeRabbit)
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
There was a problem hiding this comment.
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
docs/hardware/devices/community-supported/b-and-q-consulting/nano/index.mdx (1)
39-39: 📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick winUse
MHzconsistently for frequency units.The terminology casing update is correct, but the frequency specifications still use
Mhz; replace these occurrences with the standardMHzcasing.Also applies to: 85-85
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@docs/hardware/devices/community-supported/b-and-q-consulting/nano/index.mdx` at line 39, Update the frequency unit casing in the device frequency list by replacing every occurrence of “Mhz” with “MHz,” including all regional ranges in the Nano documentation. Preserve the existing values and formatting.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Outside diff comments:
In `@docs/hardware/devices/community-supported/b-and-q-consulting/nano/index.mdx`:
- Line 39: Update the frequency unit casing in the device frequency list by
replacing every occurrence of “Mhz” with “MHz,” including all regional ranges in
the Nano documentation. Preserve the existing values and formatting.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro Plus
Run ID: 7cac1a83-8b7a-4eb3-895c-e21e2dc20ba9
📒 Files selected for processing (2)
docs/hardware/devices/b-and-q-consulting/nano/index.mdxdocs/hardware/devices/community-supported/b-and-q-consulting/nano/index.mdx
🚧 Files skipped from review as they are similar to previous changes (1)
- docs/hardware/devices/b-and-q-consulting/nano/index.mdx
What did you change
A consistency-only terminology/casing sweep across the docs, normalizing product and technology names toward their official forms. No prose or meaning changes — only capitalization/spelling of names.
NRF52840→nRF52840(10) — Nordic's official casing, in device spec tables/bullets.ESP32S3→ESP32-S3(4) — Espressif's official casing; matches the docs' dominantESP32-S3usage.Wi-Fi→WiFi(13) — matches the docs' overwhelmingly dominant house style (WiFi~200 vsWi-Fi13).Lora→LoRa(5) — only genuine radio-technology references ("LoRa front-end circuit", "wideband LoRa antenna", "915Mhz LoRa PCB Antenna", "Meshtastic LoRa Chirp").Node-red/node-red→Node-RED(2).Why did you change it
The docs mixed several casings for the same names, flagged in an accessibility/consistency review. These are the unambiguous, official-form corrections.
Each change was scoped to prose only and deliberately avoids clobbering:
NRF52840,T-Lora Pager,TTGO Lora,Lora V2.1, etc. (LILYGO's own branding, left exactly as-is),gateway-wifiJSX values andwifi_ssid/wifi_pskconfig identifiers,nrf52840tab values / CLI args,Intentionally left for maintainers: the
meshtasticd/MeshtasticDcasing. The daemon's binary is lowercase, but the project brands its own landing pagetitle: MeshtasticDand the name appears inside image file paths, so normalizing it is a judgment call I didn't want to make unilaterally.Third of three separate docs PRs from the review (after component a11y and docs alt-text/links/headings).
Screenshots
N/A — text-only casing changes with no visual or layout impact. Diff is a symmetric +34/−34 across 22 files.
Summary by CodeRabbit