Move IQS rules into its own page

[abmantis]

Proposed change

Follow up to: #2601 (review)

Previously, the list of rules was in the middle of the top IQS page, while the "Rules" menu had no page.

This PR moves the list of rules to a new "Rules" page, which is linked from the "Rules" menu, making it easier to find the list of rules.

Type of change

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

Additional information

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

Summary by CodeRabbit

• Documentation
  • Removed the detailed explanations of the integration quality tiers from the previous documentation section.
  • Introduced a new page that clearly outlines the rules for Bronze, Silver, Gold, and Platinum tiers.
  • Updated the sidebar navigation to provide a centralized link to the integration quality rules documentation.

[coderabbitai]

📝 Walkthrough

Walkthrough

The changes update the integration quality scale documentation by removing the inline "Integration quality scale rules" section from the main overview and relocating that content to a newly created file. The new file details the tier rules (Bronze, Silver, Gold, Platinum) using <RuleOverview> components. In addition, the sidebar structure was modified to replace the direct mapping of rule document IDs with a centralized link to this new rules documentation.

Changes

File(s)	Change Summary
docs/.../integration-quality-scale/index.md docs/.../integration-quality-scale/rules.md	Removed the inline "Integration quality scale rules" section (including subsections for Bronze, Silver, Gold, and Platinum) from the overview and added a new file that details these rules with <RuleOverview> components.
sidebars.js	Modified the navigation structure by removing the inline mapping of rules and adding a centralized link to the new rules documentation entry.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Sidebar
    participant OverviewPage
    participant RulesPage

    User->>Sidebar: Open "Integration Quality Scale" section
    Sidebar->>OverviewPage: Render overview without integrated rules section
    User->>Sidebar: Click on "Rules" link
    Sidebar->>RulesPage: Navigate to rules documentation

Loading

Tip

⚡🧪 Multi-step agentic review comment chat (experimental)

• We're introducing multi-step agentic chat in review comments. This experimental feature enhances review discussions with the CodeRabbit agentic chat by enabling advanced interactions, including the ability to create pull requests directly from comments.
  - To enable this feature, set early_access to true under in the settings.

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between f11987a and 6f3247d.

📒 Files selected for processing (3)

• docs/core/integration-quality-scale/index.md (0 hunks)
• docs/core/integration-quality-scale/rules.md (1 hunks)
• sidebars.js (1 hunks)

💤 Files with no reviewable changes (1)

• docs/core/integration-quality-scale/index.md

🔇 Additional comments (2)

docs/core/integration-quality-scale/rules.md (1)

1-24: Well-organized structure for the IQS rules!

The new document is cleanly structured with clear headings for each quality tier and proper use of the RuleOverview component. The separation of rules to their own page aligns well with the PR objective of making them more easily accessible through the Rules menu.

You might consider adding a brief introductory paragraph explaining the purpose and importance of the quality scale before diving into the tiers, but otherwise, this looks great.

sidebars.js (1)

157-165: Sidebar structure properly updated to link to the new rules page

Nice work updating the sidebar configuration to point to the new dedicated rules page. This change creates a better navigation structure by:

1. Adding a proper link to the new rules document
2. Maintaining the existing structure for individual rule pages
3. Using a category to organize the rules documentation

This implementation fixes the issue mentioned in the PR objectives where the Rules menu previously didn't have a corresponding page.

✨ Finishing Touches

• 📝 Generate Docstrings

---

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

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

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)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai or @coderabbitai title anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[frenck]

Nice! Thanks, @abmantis 👍

../Frenck