Documentation/spresense: rewrite board page with images and configs#19258
Merged
Conversation
Replace the bare "README.txt literal include" with a proper reStructuredText page for the Sony Spresense board, and remove the now-redundant README.txt (all of its content has been migrated into index.rst): - Add board, extension and camera pinout figures (sony*.png). - Add Features, Serial Console, Buttons and LEDs sections. - Add "Flashing the bootloader" and "Building and Flashing" sections, including the official firmware download link and the flash_writer.py workflow. - Document all board configurations (audio, audio_sdk, camera, charger, coremark, elf, example_camera, example_lcd, fmsynth, getprime, lcd, lte, module, mpy, nsh, nsh_automount, nsh_trace, ostest, posix_spawn, rndis, rndis_composite, rndis_smp, smp, usbmsc, usbnsh, wifi, wifi_smp), each of which was verified to build. Signed-off-by: Jorge Guzman <jorge.gzm@gmail.com>
github-actions
Bot
added
Area: Documentation
Contributor
Author
|
I received this board a few years ago, and recently I decided to start using it again. While getting back to it, I realized there was a lack of good documentation explaining how to use the board. |
xiaoxiang781216
approved these changes
Jul 2, 2026
jerpelea
approved these changes
Jul 2, 2026
acassis
approved these changes
Jul 2, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Rewrites the Sony Spresense board docs, previously just a README.txt literal include, into proper reStructuredText:
Adds board/extension/camera pinout figures
Adds Features, Serial Console, Buttons and LEDs sections.
Adds bootloader-flashing and build-and-flash instructions (with the official firmware download link).
Documents all 27 board configurations (previously only 5).
Removes the now-redundant README.txt (content migrated into index.rst).
Impact
Documentation only, no source or build behavior changes. Adds three PNG figures, following the convention of other boards.
Testing
Documentation-only change.