search

zephyrproject-rtos / zephyr

Primary Git Repository for the Zephyr Project. Zephyr is a new generation, scalable, optimized, secure RTOS for multiple hardware architectures.
https://docs.zephyrproject.org
Apache License 2.0
10.77k stars 6.57k forks source link

doc: minor typo in 'boards/arm/rpi_pico/doc/index' ("Bluetoth" should be "Bluetooth") #67435

Closed RalphCorderoy closed 7 months ago

RalphCorderoy commented 9 months ago

Describe the bug

The CYW43439 is mentioned, it gives Wi-Fi and Bluetooth, but there is no explicit mention it isn't supported so the first-time visitor is left wondering. I'm left assuming it isn't supported given the following KConfig table.

Also typo: 'Bluetoth' which hinders search.

Environment

github-actions[bot] commented 9 months ago

Hi @RalphCorderoy! We appreciate you submitting your first issue for our open-source project. 🌟

Even though I'm a bot, I can assure you that the whole community is genuinely grateful for your time and effort. 🤖💙

kartben commented 9 months ago

I understand where you're coming from, but typically the intro of a board's doc page is meant to be a generic blurb presenting the hardware as per the vendor's datasheet and product page. It's expected that one should, like you apparently did, refer to the "Supported Features" section to see what's available (and probably crosscheck with what's in devicetree at a given point in time) in Zephyr specifically. It's usually up to the initial submitters and maintainers of the respective areas to which are contributed, but usually the documentation focuses on listing what's supported, and doesn't necessarily explicitly list what is not supported.

Note that Wi-Fi support on the Pico is tracked here: https://github.com/zephyrproject-rtos/zephyr/issues/67092

Could you submit a PR for fixing the Bluetoth typo?

github-actions[bot] commented 7 months ago

This issue has been marked as stale because it has been open (more than) 60 days with no activity. Remove the stale label or add a comment saying that you would like to have the label removed otherwise this issue will automatically be closed in 14 days. Note, that you can always re-open a closed issue at any time.