You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@nuttx.apache.org by "rcsim (via GitHub)" <gi...@apache.org> on 2025/03/11 02:31:00 UTC
[PR] Seeed xiao rp2350 documentation [nuttx]
rcsim opened a new pull request, #15969:
URL: https://github.com/apache/nuttx/pull/15969
## Summary
This PR adds the documentation for XIAO RP2350 Board.
It includes general board description, features, and pins and also how users can build nsh, usbnsh and jumbo configs.
Also fix case for XIAO RP2040 and XIAO SAMD21
## Impact
Users can read the documentation and run NuttX at XIAO RP2350
## Testing
Build the documentation and check the output on browser:
```
cd Documentation/
pipenv shell
make html
xdg-open _build/html/index.html
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@nuttx.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Seeed xiao rp2350 documentation [nuttx]
Posted by "nuttxpr (via GitHub)" <gi...@apache.org>.
nuttxpr commented on PR #15969:
URL: https://github.com/apache/nuttx/pull/15969#issuecomment-2712361934
[**\[Experimental Bot, please feedback here\]**](https://github.com/search?q=repo%3Aapache%2Fnuttx+13552&type=issues)
Yes, this PR appears to meet the basic NuttX requirements, although some sections could be more detailed. Here's a breakdown:
**Strengths:**
* **Clear Summary:** The summary explains the "what" and "why" of the change.
* **Impact on User Addressed:** The impact on the user (ability to use XIAO RP2350) is clearly stated.
* **Testing Provided:** Testing steps for the documentation are included.
**Areas for Improvement:**
* **Missing Detail in Summary:** While the summary covers the changes made *to the documentation*, it doesn't explicitly mention what *functional changes* (if any) are being made to the NuttX codebase itself due to the XIAO RP2350 support. If this PR only adds documentation, that should be explicitly stated. If it also adds board support code, that should be described briefly.
* **Impact - Overly Concise:** While the user impact is mentioned, other impact sections are simply "NO" without explanation. Even if there's no impact, briefly stating "NO - No changes to the build process" adds clarity.
* **Testing - Limited Scope:** Testing only covers building the documentation. If this PR enables support for the XIAO RP2350 board, testing should also include building and running NuttX on the actual hardware (or a simulator if applicable). Providing "before" logs isn't relevant for new documentation; focus on "after" logs showing the rendered documentation or successful builds/runs on the target.
* **Missing Hardware Details:** The "Testing" section should specify the Build Host details used to build the documentation. While it mentions the target (XIAO RP2350), it doesn't provide details like the toolchain used.
**Recommendation:**
Expand the PR description to provide more specifics, especially in the "Impact" and "Testing" sections. Demonstrating that the documentation builds *and* that the newly documented board support works as expected will significantly strengthen the PR.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@nuttx.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Seeed xiao rp2350 documentation [nuttx]
Posted by "acassis (via GitHub)" <gi...@apache.org>.
acassis merged PR #15969:
URL: https://github.com/apache/nuttx/pull/15969
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@nuttx.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org