-
-
Notifications
You must be signed in to change notification settings - Fork 7.8k
Update rpi_camera.markdown #39815
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
Update rpi_camera.markdown #39815
Conversation
Fixed links to Raspberry Pi documentation as per home-assistant#39756
✅ Deploy Preview for home-assistant-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
📝 WalkthroughWalkthroughThe documentation for the Changes
Assessment against linked issues
Assessment against linked issues: Out-of-scope changesNo out-of-scope changes detected. Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 0
🧹 Nitpick comments (2)
source/_integrations/rpi_camera.markdown (2)
18-18
: Improve wording & add missing article“…to store the image from camera.” reads a bit awkwardly. Switching to “capture images from the camera” adds the missing article and better reflects what
rpicam-still
actually does.-The `rpi_camera` {% term integration %} allows you to integrate the Raspberry Pi camera into Home Assistant. This integration uses the application [`rpicam-still`](https://www.raspberrypi.com/documentation/computers/camera_software.html#rpicam-still) to store the image from camera. +The `rpi_camera` {% term integration %} allows you to integrate the Raspberry Pi camera into Home Assistant. This integration uses the application [`rpicam-still`](https://www.raspberrypi.com/documentation/computers/camera_software.html#rpicam-still) to capture images from the camera.
34-34
: Optional: deep-link directly to the CLI options sectionThe second link points to exactly the same page as the previous link. If the intent is to direct users to the list of CLI parameters, consider linking to the “Options” / “Command-line parameters” section (e.g.
#options
) instead, so readers land on the relevant table immediately.No action required, purely a UX improvement.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting
📒 Files selected for processing (1)
source/_integrations/rpi_camera.markdown
(2 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_integrations/rpi_camera.markdown
[uncategorized] ~18-~18: You might be missing the article “the” here.
Context: ...l#rpicam-still) to store the image from camera. {% important %} This integration is o...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
⏰ Context from checks skipped due to timeout of 90000ms (3)
- GitHub Check: Redirect rules - home-assistant-docs
- GitHub Check: Header rules - home-assistant-docs
- GitHub Check: Pages changed - home-assistant-docs
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you for the catch, @ecspiegel 👍
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 0
🧹 Nitpick comments (3)
source/_integrations/rpi_camera.markdown (3)
18-18
: Fix minor grammatical issue in camera descriptionSmall wording tweak makes the sentence read more naturally.
-The `rpi_camera` {% term integration %} allows you to integrate the Raspberry Pi camera into Home Assistant. This integration uses the application [`rpicam-still`](https://www.raspberrypi.com/documentation/computers/camera_software.html#rpicam-still) to store the image from camera. +The `rpi_camera` {% term integration %} allows you to integrate the Raspberry Pi camera into Home Assistant. This integration uses the application [`rpicam-still`](https://www.raspberrypi.com/documentation/computers/camera_software.html#rpicam-still) to capture images from the camera.
34-35
: Optional wording improvement for clarityThe phrase “documentation of the camera software” is a bit clunky. Consider re-phrasing:
-The whole set of configuration variables is documented in the Raspberry Pi documentation of the camera software +The full set of configuration variables is documented in the Raspberry Pi camera-software documentation
78-80
: Link still points at legacyraspistill
docsThe
overlay_metadata
reference links to the old “camera.md” page that documentsraspistill
. To stay consistent with the switch torpicam-still
, update this URL (or verify an equivalent section exists in the new docs).
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting
📒 Files selected for processing (1)
source/_integrations/rpi_camera.markdown
(2 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_integrations/rpi_camera.markdown
[uncategorized] ~18-~18: You might be missing the article “the” here.
Context: ...l#rpicam-still) to store the image from camera. {% important %} This integration is o...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
⏰ Context from checks skipped due to timeout of 90000ms (3)
- GitHub Check: Redirect rules - home-assistant-docs
- GitHub Check: Header rules - home-assistant-docs
- GitHub Check: Pages changed - home-assistant-docs
Fixed links to Raspberry Pi documentation as per #39756
Proposed change
Type of change
current
branch).current
branch).next
branch).next
branch).Additional information
Checklist
current
branch.next
branch.Summary by CodeRabbit
Summary by CodeRabbit
rpicam-still
instead ofraspistill
for Raspberry Pi camera integration.