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

Documentation: update uorb and sensor driver doc #15557

Merged
merged 1 commit into from
Jan 15, 2025
Merged

Conversation

Donny9
Copy link
Contributor

@Donny9 Donny9 commented Jan 15, 2025

Summary

Documentation: update uorb and sensor driver doc, include uorb usage and sensor driver introduce.

Impact

N/A

Testing

make html

@github-actions github-actions bot added Area: Documentation Improvements or additions to documentation Size: XL The size of the change in this PR is very large. Consider breaking down the PR into smaller pieces. labels Jan 15, 2025
@nuttxpr
Copy link

nuttxpr commented Jan 15, 2025

[Experimental Bot, please feedback here]

No. This PR does not fully meet the NuttX requirements. The summary is too brief and lacks crucial information. It doesn't explain why the documentation update is necessary (bug fix, clarification, new feature documentation, etc.), what functional parts of the documentation are changed (specific files or sections), or how the changes improve the documentation.

The "Impact" section uses "N/A" which is discouraged. Even documentation changes have an impact (positive hopefully!). At a minimum, it should state "Impact on documentation: YES - This PR updates the documentation for uORB and sensor drivers to include usage information and an introduction to sensor drivers."

The "Testing" section is insufficient. "make html" only confirms the documentation builds. It doesn't demonstrate that the content of the documentation is correct, complete, and helpful. Ideally, you would describe how you verified the documentation's accuracy (e.g., "Followed the updated uORB usage instructions and confirmed they work as described"). While testing documentation can be different from testing code, it still requires verification.

@raiden00pl raiden00pl merged commit 500b55c into apache:master Jan 15, 2025
3 checks passed
@raiden00pl
Copy link
Member

@Donny9 thanks for this. In the future try to follow recommended headings style for sections from here: https://nuttx.apache.org/docs/latest/contributing/documentation.html#headings

I'll fix that now, as I'm just working on this section of the doc

@raiden00pl
Copy link
Member

@Donny9 do you have this image https://github.com/apache/nuttx/pull/15557/files#diff-f7365cd8c454337abe9252b36a4a04513ca4f83d3a6c35e92b51f53894442904 but without watermarks ? They are barely visible, but if you look closely you can see them :)

@Donny9
Copy link
Contributor Author

Donny9 commented Jan 15, 2025

@Donny9 do you have this image https://github.com/apache/nuttx/pull/15557/files#diff-f7365cd8c454337abe9252b36a4a04513ca4f83d3a6c35e92b51f53894442904 but without watermarks ? They are barely visible, but if you look closely you can see them :)

Let me think if there are other methods. All our materials will be watermarked. @raiden00pl

@xiaoxiang781216
Copy link
Contributor

@Donny9 there a trick to download the picture without watermark, let's talk offline.

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: XL The size of the change in this PR is very large. Consider breaking down the PR into smaller pieces.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants