Skip to content

Commit 8334ca2

Browse files
kartbendkalowsk
authored andcommitted
doc: porting_guide: encourage the use of webp for board images
It's already mentioned in the board.tmpl template file as well as in documentation writing guidelines so fix this leftover and make sure people contributing boards aim for webp format as it helps with file size while supporting transparency. Signed-off-by: Benjamin Cabé <[email protected]>
1 parent 9f93ded commit 8334ca2

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

doc/hardware/porting/board_porting.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -261,7 +261,7 @@ Your board directory should look like this:
261261
├── board.cmake
262262
├── CMakeLists.txt
263263
├── doc
264-
│   ├── plank.png
264+
│   ├── plank.webp
265265
│   └── index.rst
266266
├── Kconfig.plank
267267
├── Kconfig.defconfig
@@ -299,7 +299,7 @@ The optional files are:
299299
- :file:`board.cmake`: used for :ref:`flash-and-debug-support`
300300
- :file:`CMakeLists.txt`: if you need to add additional source files to
301301
your build.
302-
- :file:`doc/index.rst`, :file:`doc/plank.png`: documentation for and a picture
302+
- :file:`doc/index.rst`, :file:`doc/plank.webp`: documentation for and a picture
303303
of your board. You only need this if you're :ref:`contributing-your-board` to
304304
Zephyr.
305305
- :file:`plank_<qualifiers>.yaml`: a YAML file with miscellaneous metadata used

0 commit comments

Comments
 (0)