Skip to content

boards: espressif: fix chapter name #95335

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
Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

boards: espressif: fix chapter name #95335

wants to merge 2 commits into from
+100 −64

Conversation

marekmatej
Copy link

@marekmatej marekmatej commented Sep 2, 2025 •
edited by kartben
Loading

Change the chapter name so it is not duplicating the included chapter name.

https://builds.zephyrproject.io/zephyr/pr/95335/docs/boards/index.html#vendor=espressif

@marekmatej marekmatej force-pushed the bugfix/esp_doc_chapters branch 3 times, most recently from 74c4510 to fd1658d Compare September 5, 2025 12:40
@marekmatej marekmatej marked this pull request as ready for review September 5, 2025 12:59
@marekmatej marekmatej requested a review from kartben September 5, 2025 12:59
@zephyrbot zephyrbot added the platform: ESP32 Espressif ESP32 label Sep 5, 2025
kartben
kartben requested changes Sep 5, 2025
View reviewed changes
Copy link
Contributor

@kartben kartben left a comment

Choose a reason for hiding this comment

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

mmh just remove "Building and Flashing" from building-flashing.rst? :)

raffarost
raffarost reviewed Sep 5, 2025
View reviewed changes
boards/espressif/esp32_devkitc/doc/index.rst
Building and Flashing
*********************
Programming & Debugging tool support
************************************

.. zephyr:board-supported-runners::
Copy link

@raffarost raffarost Sep 5, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

wouldn't it fit better to call the section "Runners" or "Supported Runners"?

Copy link
Contributor

@kartben kartben Sep 5, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

"Programming & Debugging" is how a vast majority of the boards call this section, fwiw

Copy link
Contributor

Choose a reason for hiding this comment

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

@marekmatej ☝🏻

Copy link
Author

Choose a reason for hiding this comment

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

@kartben usually we don't have common "Debugging" instructions for all boards, therefore I've chosen "Building & Flashing" as a chapter name. Also fixed heading for supported runners as @raffarost has suggested.

Copy link
Contributor

Choose a reason for hiding this comment

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

not sure I understand. What's wrong with the structure from the board template?
https://github.com/zephyrproject-rtos/zephyr/blob/main/doc/templates/board.tmpl
It shouldn't matter whether the debugging instructions are common or not?

Copy link
Contributor

Choose a reason for hiding this comment

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

@marekmatej ping

Copy link
Author

Choose a reason for hiding this comment

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

updated

@marekmatej
Copy link
Author

mmh just remove "Building and Flashing" from building-flashing.rst? :)

This was my first try, but I got an error due to "missing title"

@kartben
Copy link
Contributor

kartben commented Sep 5, 2025

mmh just remove "Building and Flashing" from building-flashing.rst? :)

This was my first try, but I got an error due to "missing title"

Right, I think I know why. If you're ok with this I can directly post the solution to your branch

@marekmatej
Copy link
Author

Right, I think I know why. If you're ok with this I can directly post the solution to your branch

Sounds mysterious ;) but sure, go ahead!

@kartben
Copy link
Contributor

kartben commented Sep 5, 2025

Right, I think I know why. If you're ok with this I can directly post the solution to your branch

Sounds mysterious ;) but sure, go ahead!

well actually there is no such issue about "missing title"?

@kartben kartben force-pushed the bugfix/esp_doc_chapters branch 2 times, most recently from eb917ec to 37be500 Compare September 6, 2025 21:18
@marekmatej marekmatej force-pushed the bugfix/esp_doc_chapters branch 2 times, most recently from 4de9bbe to e8dbfdc Compare September 9, 2025 12:19
wmrsouza
wmrsouza previously approved these changes Sep 9, 2025
View reviewed changes
raffarost
raffarost previously approved these changes Sep 9, 2025
View reviewed changes
uLipe
uLipe previously approved these changes Sep 9, 2025
View reviewed changes
sylvioalves
sylvioalves previously approved these changes Sep 11, 2025
View reviewed changes
@marekmatej marekmatej dismissed stale reviews from sylvioalves and uLipe via 7eb1a39 September 11, 2025 16:08
@marekmatej marekmatej dismissed stale reviews from raffarost and wmrsouza via 7eb1a39 September 11, 2025 16:08
@marekmatej marekmatej force-pushed the bugfix/esp_doc_chapters branch from e8dbfdc to 7eb1a39 Compare September 11, 2025 16:08
@zephyrbot zephyrbot added the area: Shields Shields (add-on boards) label Sep 11, 2025
@marekmatej marekmatej added the DNM This PR should not be merged (Do Not Merge) label Sep 11, 2025
@marekmatej marekmatej force-pushed the bugfix/esp_doc_chapters branch from 7eb1a39 to e7cc267 Compare September 12, 2025 10:59
Marek Matej added 2 commits September 12, 2025 13:35
boards: espressif: Fix chapters heading
da65465 
Fix chapters and included rst section heading.

Signed-off-by: Marek Matej <marek.matej@espressif.com>
boards: espressif: Fix more images
f5c4eaf 
Fix file format of the board and shield images.

Signed-off-by: Marek Matej <marek.matej@espressif.com>
@marekmatej marekmatej force-pushed the bugfix/esp_doc_chapters branch from e7cc267 to f5c4eaf Compare September 12, 2025 11:35
@sonarqubecloud SonarQubeCloud
Copy link

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@uLipe uLipe uLipe left review comments

@sylvioalves sylvioalves sylvioalves left review comments

@wmrsouza wmrsouza wmrsouza left review comments

@raffarost raffarost raffarost left review comments

@LucasTambor LucasTambor Awaiting requested review from LucasTambor

@kartben kartben Awaiting requested review from kartben

@avisconti avisconti Awaiting requested review from avisconti

@erwango erwango Awaiting requested review from erwango

@jfischer-no jfischer-no Awaiting requested review from jfischer-no

Requested changes must be addressed to merge this pull request.

Assignees

@sylvioalves sylvioalves

Labels
area: Shields Shields (add-on boards) DNM This PR should not be merged (Do Not Merge) platform: ESP32 Espressif ESP32
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
7 participants
@marekmatej @kartben @uLipe @sylvioalves @wmrsouza @raffarost @zephyrbot