-
Notifications
You must be signed in to change notification settings - Fork 8.4k
doc: boards: Migrate -many- boards to new zephyr:board directive/role #80048
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.
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
doc: boards: Migrate -many- boards to new zephyr:board directive/role #80048
Conversation
5c51944 to
251d0a7
Compare
5c5965b to
80e771c
Compare
This updates the documentation of all the Gaisler boards to use the new `zephyr:board::` directive. Signed-off-by: Benjamin Cabé <[email protected]>
This updates the documentation of all the Khadas boards to use the new `zephyr:board::` directive. Signed-off-by: Benjamin Cabé <[email protected]>
This updates the documentation of all the Ronoth boards to use the new `zephyr:board::` directive. Signed-off-by: Benjamin Cabé <[email protected]>
This updates the documentation of all the Firefly boards to use the new `zephyr:board::` directive. Signed-off-by: Benjamin Cabé <[email protected]>
This updates the documentation of all the Qorvo boards to use the new `zephyr:board::` directive. Signed-off-by: Benjamin Cabé <[email protected]>
This updates the documentation of all the SECO boards to use the new `zephyr:board::` directive. Signed-off-by: Benjamin Cabé <[email protected]>
This updates the documentation of all the Space Cubics boards to use the new `zephyr:board::` directive. Signed-off-by: Benjamin Cabé <[email protected]>
This updates the documentation of all the DPTechnics boards to use the new `zephyr:board::` directive. Signed-off-by: Benjamin Cabé <[email protected]>
This updates the documentation of all the Rasperry Pi boards to use the new `zephyr:board::` directive. Signed-off-by: Benjamin Cabé <[email protected]>
This updates the documentation of all the Contextual Electronics boards to use the new `zephyr:board::` directive. Signed-off-by: Benjamin Cabé <[email protected]>
This updates the documentation of all the "others" boards to use the new `zephyr:board::` directive. Signed-off-by: Benjamin Cabé <[email protected]>
This updates the documentation of all the WeAct boards to use the new `zephyr:board::` directive. Signed-off-by: Benjamin Cabé <[email protected]>
This updates the documentation of all the Qemu boards to use the new `zephyr:board::` directive. Signed-off-by: Benjamin Cabé <[email protected]>
This updates the documentation of all the CThings boards to use the new `zephyr:board::` directive. Signed-off-by: Benjamin Cabé <[email protected]>
This updates the documentation of all the Franzininho boards to use the new `zephyr:board::` directive. Signed-off-by: Benjamin Cabé <[email protected]>
This updates the documentation of all the Cadence boards to use the new `zephyr:board::` directive. Signed-off-by: Benjamin Cabé <[email protected]>
This updates the documentation of all the Element14 boards to use the new `zephyr:board::` directive. Signed-off-by: Benjamin Cabé <[email protected]>
This updates the documentation of all the SiFive boards to use the new `zephyr:board::` directive. Signed-off-by: Benjamin Cabé <[email protected]>
7968c79 to
4a1a2b7
Compare
|
|
Hi @kartben , No image from Atmel / GD should be removed. They are images from the development kit and should be kept. |
@nandojve |
I understood now. The below don't affect the the outcome. -.. image:: img/gd32a503v_eval.jpg
- :align: center
- :alt: gd32a503v_evalSorry about the noise. |
That's no problem at all, really! I understand how the change can be confusing at first sight so no worries :) |
pdgendt
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nice work!
Examples of the PR applied to some boards:
Kind of a big PR, but it's split in commits per vendor -- as some of the documentation pages (ex. samples) that now reference boards using the new
:zephyr:board:directive sometimes mention multiple boards on the same line, this would lead to many conflicts based on the order in which PR are merged if I am to split the changes in multiple PRs.There are still quite a few boards/vendors to migrate over but thought I would get the ball rolling :)
Some of the documentation pages that haven't been migrated yet are typically:
.. zephyr:board::directive is designed for only one board per doc page at the moment (ex. https://docs.zephyrproject.org/latest/boards/intel/adl/doc/index.html which targets bothintel_adl_crbandintel_adl_rvp)When it comes to deciding whether the main image in a board documentation page should be removed to only appear in the new "card", the thought process has been that whenever the image really only was there for illustration purposes, it's been removed (ex. https://builds.zephyrproject.io/zephyr/pr/80048/docs/boards/m5stack/m5stack_atoms3/doc/index.html) but when it is part of a narrative where being able to see the image right next to the text mentioning it, it's been preserved (but also appears in the card); ex. https://builds.zephyrproject.io/zephyr/pr/80048/docs/boards/particle/nrf51_blenano/doc/index.html#connections-and-ios