Skip to content
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

Add STM32H5 architecture documentation. #15771

Merged
merged 1 commit into from
Feb 8, 2025

Conversation

kywwilson11
Copy link
Contributor

Summary

Added documentation for STM32H5 Architecture and Nucleo-H563ZI board.

There is support for a handful of peripherals right now. Adding documentation will hopefully encourage others to contribute to the STM32H5 port.

Impact

No impact to code. Only documentation will be updated for STM32H5.

Testing

Used online rst previewer to check formatting in index.rst files.

@github-actions github-actions bot added Area: Documentation Improvements or additions to documentation Size: M The size of the change in this PR is medium labels Feb 5, 2025
@kywwilson11 kywwilson11 force-pushed the stm32h5_documentation branch from aaf1d9f to efb9ec4 Compare February 5, 2025 18:11
@nuttxpr
Copy link

nuttxpr commented Feb 5, 2025

[Experimental Bot, please feedback here]

Yes, this PR appears to meet the basic NuttX requirements, although it could be more thorough. While it addresses the key areas, it lacks specific details in a few sections, which could hinder review and acceptance.

Here's a breakdown:

  • Summary: Adequate. Clearly states the change (documentation addition) and its purpose (encouraging contributions). It could be improved by linking to a related issue if one exists.

  • Impact: Mostly adequate. While it correctly states no impact on code, it lacks specificity in the documentation update. Which documentation files are being changed? Listing the modified files directly (e.g., arch/arm/src/stm32h5/README.txt, boards/arm/stm32h5/nucleo-h563zi/README.txt) would be helpful. Explicitly stating "NO" for all other impact categories is good.

  • Testing: Insufficient. While checking formatting with a previewer is a good first step, it doesn't demonstrate that the content is accurate or complete. Ideally, you should show some interaction with the hardware or at least the simulator. For example:

    • If possible, build and run a simple "Hello World" on the Nucleo-H563ZI and confirm it works as expected.
    • If hardware isn't readily available, use the simulator (sim:nsh) to demonstrate basic functionality and include a screenshot or console output.
    • Even simply stating "Built successfully for nucleo-h563zi config with no errors" is better than just formatting checks.

    The "Testing logs before change" and "Testing logs after change" sections should not be empty. Since this is documentation, the "after" logs could include relevant excerpts from the generated documentation or output related to the build process.

Recommendation: Strengthen the Testing section with concrete examples. Be specific about the documentation files changed in the Impact section. Consider creating a related issue if one doesn't exist and link it in the Summary. These small additions will significantly improve the PR's clarity and chances of acceptance.

Copy link
Contributor

@acassis acassis left a comment

Choose a reason for hiding this comment

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

@kywwilson11 you missed to include a picture of the board.

All the boards Documentation/ needs to include a picture of the board. Some are missing because they are old contribution or someone failed to ask it during the review!

Add documentation for nucleo-h563zi development board.

Removed whitespace at the end of lines.

Fixed column formatting.

Fixed Title overline too short error.

Added image to nucleo-h563zi documentation.
@kywwilson11 kywwilson11 force-pushed the stm32h5_documentation branch from 14ddf73 to a9aae40 Compare February 7, 2025 16:05
@kywwilson11
Copy link
Contributor Author

I added an image of the Nucleo-H563ZI, and included it in the board documentation. Thank you for the feedback.

@anchao anchao merged commit ac0ba3f into apache:master Feb 8, 2025
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Area: Documentation Improvements or additions to documentation Size: M The size of the change in this PR is medium
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants