Skip to content

Documentation: do not refer to custom components #2893

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.

Sign up for GitHub

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

Jump to bottom
Open
c0ffeeca7 wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Documentation: do not refer to custom components #2893

c0ffeeca7 wants to merge 1 commit into from

Conversation

@c0ffeeca7
Copy link
Contributor

@c0ffeeca7 c0ffeeca7 commented Dec 16, 2025 •
edited by coderabbitai bot
Loading

Proposed change

Type of change

  • Document existing features within Home Assistant
  • Document new or changing features for which there is an existing pull request elsewhere
  • Spelling or grammatical corrections, or rewording for improved clarity
  • Changes to the backend of this documentation
  • Remove stale or deprecated documentation

Checklist

  • I have read and followed the documentation guidelines.
  • I have verified that my changes render correctly in the documentation.

Additional information

  • This PR fixes or closes issue: fixes #
  • Link to relevant existing code or pull request:

Summary by CodeRabbit

  • Documentation
    • Updated page creation documentation with clarified guidance on custom integration references and standardized terminology.
    • Enhanced PR preparation instructions for better clarity on review readiness procedures.

✏️ Tip: You can customize this high-level summary in your review settings.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Dec 16, 2025

📝 Walkthrough

Walkthrough

Documentation page creation guidelines are updated to replace device type validation requirements with custom integration constraints, standardizing terminology and adding an explicit step for removing comments before PR submission.

Changes

Cohort / File(s) Summary
Documentation Guidelines Update
docs/documenting/create-page.md		 Steps 6–7 replaced with new requirements prohibiting references to custom integrations and custom card dependencies; device type wording standardized from "incl." to "including"; step 8 added as explicit reminder to remove comments before marking PR ready for review.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

  • Verify accuracy of new custom integration constraints and clarity of guidance
  • Confirm wording standardization ("incl." → "including") is applied consistently

Pre-merge checks and finishing touches

❌ Failed checks (1 inconclusive)
Check name Status Explanation Resolution
Description check ❓ Inconclusive The PR description follows the template structure with type of change selected and checklists completed, but the 'Proposed change' section is empty, leaving the core rationale unexplained. Fill in the 'Proposed change' section to explain why this documentation update is necessary and what problem it addresses.
✅ Passed checks (2 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly describes the main change: adding guidance that documentation should not refer to custom components, which directly aligns with the file modifications summarized.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch docs-add-step-not-to-refer-to-custom-components
📜 Recent 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

📥 Commits

Reviewing files that changed from the base of the PR and between 5c47ab2 and 94f1b91.

📒 Files selected for processing (1)
  • docs/documenting/create-page.md (1 hunks)
🔇 Additional comments (3)
docs/documenting/create-page.md (3)

16-16: Verify terminology specificity for "custom integrations" and "custom cards".

The new requirement uses more specific terminology ("custom integrations" and "custom cards") than the PR title ("custom components"). This is actually clearer for documentation writers, but I want to confirm this specificity is intentional and current with Home Assistant's ecosystem terminology.

Please verify:

  • Is "custom cards" the appropriate term (or should it reference "custom frontend components" or similar)?
  • Are there other types of custom components that should be mentioned?

17-17: Wording improvement for clarity.

Changing "incl." to "including" improves readability and consistency with documentation standards. This is a good quality improvement.

18-18: Verify context and placement of step 8.

The new step 8 about removing comments before PR submission appears reasonable, but the AI summary indicates this "mirrors prior removal instruction." Please clarify:

  • Was this instruction previously documented elsewhere in this or another documentation file?
  • Is this a restructuring/promotion to an explicit numbered step, or a new requirement?
  • Does the placement as the final step make sense in the PR submission workflow?

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@c0ffeeca7