Skip to content
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

Jump to bottom

Doc: Readme does not contain reference in correct order to ESP32-S3-BOX-3 (BSP-597) #456

Closed
1 task done
georgik opened this issue Dec 13, 2024 · 2 comments · Fixed by #467
Closed
1 task done

Doc: Readme does not contain reference in correct order to ESP32-S3-BOX-3 (BSP-597) #456

georgik opened this issue Dec 13, 2024 · 2 comments · Fixed by #467
Assignees
@tore-espressif
Labels
documentation 📝 Solely about the documentation of the project. Status: Review needed PR is awaiting review. Type: Bug Something isn't working

Comments

@georgik
Copy link
Contributor

georgik commented Dec 13, 2024 •
edited
Loading

Board

ESP32-S3-BOX-3

Hardware Description

ESP32-S3-BOX-3

IDE Name

CLion

Operating System

macOS

Description

The REAMDE file https://github.com/espressif/esp-bsp?tab=readme-ov-file#supported-boards does contain link to ESP32-S3-BOX-3, yet it's low in the list. It's bellow ESP32-S3-BOX which is no longer available on the market.

Please, update the README, so that boards are sorted eaither by order. And preference should have boards which are available on the market.

Sketch

ESP32-S3-BOX-3

Other Steps to Reproduce

No response

I have checked existing issues, README.md and ESP32 Forum

  • I confirm I have checked existing issues, online documentation and Troubleshooting guide.
@georgik georgik added Status: Awaiting triage Type: Bug Something isn't working labels Dec 13, 2024
@github-actions github-actions bot changed the title Doc: Readme does not contain reference to ESP32-S3-BOX-3 Doc: Readme does not contain reference to ESP32-S3-BOX-3 (BSP-597) Dec 13, 2024
@georgik georgik changed the title Doc: Readme does not contain reference to ESP32-S3-BOX-3 (BSP-597) Doc: Readme does not contain reference in correct order to ESP32-S3-BOX-3 (BSP-597) Dec 13, 2024
@espzav
Copy link
Collaborator

espzav commented Dec 13, 2024

Here it is:
image

@georgik
Copy link
Contributor Author

georgik commented Dec 13, 2024 •
edited
Loading

@espzav Please, update the README, so that boards are sorted by alphabetical order. Another option is to put first boards which are available on the market.
Listing boards which are not selling anymore at the top IMO does not make sense.

@tore-espressif tore-espressif mentioned this issue Jan 3, 2025
Merged
@tore-espressif tore-espressif self-assigned this Jan 3, 2025
@tore-espressif tore-espressif added Status: Review needed PR is awaiting review. documentation 📝 Solely about the documentation of the project. and removed Status: Awaiting triage labels Jan 3, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@tore-espressif tore-espressif

Labels
documentation 📝 Solely about the documentation of the project. Status: Review needed PR is awaiting review. Type: Bug Something isn't working
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

docs: Move deprecated BSPs to deprecated section espressif/esp-bsp
3 participants
@georgik @tore-espressif @espzav