documentation icon indicating copy to clipboard operation
documentation copied to clipboard

Fix glossary link in `prerequisites.md`

Open corneliusludmann opened this issue 1 year ago • 1 comments

corneliusludmann avatar Sep 23 '24 11:09 corneliusludmann

📝 Walkthrough

Walkthrough

This pull request introduces a minor yet important update to the prerequisites documentation for HACS. The change involves correcting the URL for the glossary reference, ensuring users are directed to the right page for add-ons. While the modification is small, it enhances the accuracy of navigation within the documentation. No alterations were made to the exported or public entities.

Changes

File Path Change Summary
source/docs/use/download/prerequisites.md Updated glossary URL from https://www.home-assistant.io/glossary/#add-on to https://www.home-assistant.io/docs/glossary/#add-on

Possibly related PRs

  • #477: Modifies the prerequisites.md file to enhance user guidance for HACS, relating to the documentation changes in the main PR.
  • #480: Clarifies prerequisites in the same prerequisites.md file, making it relevant to the main PR's focus on documentation accuracy.
  • #529: Rephrases and clarifies content in the prerequisites.md file, aligning with the goal of improving documentation clarity.

Suggested reviewers

  • ludeeus: Suggested as a reviewer for their expertise in the relevant documentation changes.

Why did the documentation go to therapy? It had too many unresolved issues! But thankfully, this PR helps clear things up!


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

‼️ IMPORTANT Auto-reply has been disabled for this repository in the CodeRabbit settings. The CodeRabbit bot will not respond to your replies unless it is explicitly tagged.

  • 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 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 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.

coderabbitai[bot] avatar Sep 23 '24 11:09 coderabbitai[bot]