Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Update join-the-community.markdown #39334

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
Draft
wants to merge 1 commit into
base: current
Choose a base branch
from
Draft

Update join-the-community.markdown #39334

wants to merge 1 commit into from

Conversation

jackjourneyman
Copy link
Contributor

@jackjourneyman jackjourneyman commented May 31, 2025 •
edited by coderabbitai bot
Loading

Adds link to Home Assistant Cookbook

Proposed change

Type of change

  • Spelling, grammar or other readability improvements (current branch).
  • [x ] Adjusted missing or incorrect information in the current documentation (current branch).
  • Added documentation for a new integration I'm adding to Home Assistant (next branch).
  • Added documentation for a new feature I'm adding to Home Assistant (next branch).
  • Removed stale or deprecated documentation.

Additional information

  • Link to parent pull request in the codebase:
  • Link to parent pull request in the Brands repository:
  • This PR fixes or closes issue: fixes #

Checklist

  • This PR uses the correct branch, based on one of the following:
    • I made a change to the existing documentation and used the current branch.
    • I made a change that is related to an upcoming version of Home Assistant and used the next branch.
  • The documentation follows the Home Assistant documentation standards.

Summary by CodeRabbit

  • Documentation
    • Added a link to the "Home Assistant Cookbook" forum page in the community resources section for easier access to user-contributed guides and tips.

@jackjourneyman
Update join-the-community.markdown
e9275b9 
Adds link to Home Assistant Cookbook
@home-assistant home-assistant bot added the current This PR goes into the current branch label May 31, 2025
@netlify Netlify
Copy link

netlify bot commented May 31, 2025 •
edited
Loading

✅ Deploy Preview for home-assistant-docs ready!

Name Link
🔨 Latest commit e9275b9
🔍 Latest deploy log https://app.netlify.com/projects/home-assistant-docs/deploys/683b446cf47bef00081d4b8a
😎 Deploy Preview https://deploy-preview-39334--home-assistant-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@coderabbitai coderabbitai
Copy link
Contributor

coderabbitai bot commented May 31, 2025

📝 Walkthrough

Walkthrough

A new bullet point linking to the "Home Assistant Cookbook" forum page was added to the community resources list in the documentation. No other content or structure was changed.

Changes

File Change Summary
source/getting-started/join-the-community.markdown Added a bullet point linking to the "Cookbook" forum

Sequence Diagram(s)

No sequence diagram is generated as the change is a documentation update without control flow or feature logic.

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
🪧 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.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

Support

Need 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)

  • @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 generate sequence diagram to generate a sequence diagram of the changes in 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.

coderabbitai[bot]
coderabbitai bot reviewed May 31, 2025
View reviewed changes
Copy link
Contributor

@coderabbitai coderabbitai bot left a 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 (1)
source/getting-started/join-the-community.markdown (1)

12-12: Unify link style and phrasing for consistency
The new bullet currently uses an inline link and “Have a look at the forum’s…”, whereas other items employ reference-style links and slightly different wording. To align with existing conventions, consider:

  1. Converting to a reference link by adding at the bottom: 
    [home-assistant-cookbook]: https://community.home-assistant.io/t/the-home-assistant-cookbook-index/707144
  2. Updating the bullet to: 
    - Take a look in [our forums] at the Home Assistant Cookbook [home-assistant-cookbook]

This change will maintain link-definition consistency and use the more common American English idiom.

🧰 Tools
🪛 LanguageTool

[locale-violation] ~12-~12: In American English, “take a look” is more commonly used.
Context: ...unity in [our forums] or [our chat]. - Have a look at the forum's [Home Assistant Cookbook...

(HAVE_A_LOOK)

🪛 markdownlint-cli2 (0.17.2)

12-12: Unordered list indentation
Expected: 0; Actual: 1

(MD007, ul-indent)

📜 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 87bce7b and e9275b9.

📒 Files selected for processing (1)
  • source/getting-started/join-the-community.markdown (1 hunks)
🧰 Additional context used
🪛 LanguageTool
source/getting-started/join-the-community.markdown

[locale-violation] ~12-~12: In American English, “take a look” is more commonly used.
Context: ...unity in [our forums] or [our chat]. - Have a look at the forum's [Home Assistant Cookbook...

(HAVE_A_LOOK)

🪛 markdownlint-cli2 (0.17.2)
source/getting-started/join-the-community.markdown

12-12: Unordered list indentation
Expected: 0; Actual: 1

(MD007, ul-indent)

⏰ Context from checks skipped due to timeout of 90000ms (4)
  • GitHub Check: Redirect rules - home-assistant-docs
  • GitHub Check: Header rules - home-assistant-docs
  • GitHub Check: Pages changed - home-assistant-docs
  • GitHub Check: Lint Markdown

frenck
frenck requested changes Jun 1, 2025
View reviewed changes
source/getting-started/join-the-community.markdown
@@ -9,6 +9,7 @@ Now that you've got that going, let's see what is next:

- Learn about [next steps](/getting-started/configuration/) of the getting started guide, such as creating a backup or configuring network storage.
- Join the community in [our forums] or [our chat].
- Have a look at the forum's [Home Assistant Cookbook](https://community.home-assistant.io/t/the-home-assistant-cookbook-index/707144)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I appreciate the effort, but if that guide contain things someone would need, we should add the to the documentation instead of linking away from it.

../Frenck

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for your response. Not sure how to interpret it - are you saying that the things in the Home Assistant Cookbook are not "needed".

@home-assistant home-assistant bot marked this pull request as draft June 1, 2025 20:24
@home-assistant
Copy link

home-assistant bot commented Jun 1, 2025

Please take a look at the requested changes, and use the Ready for review button when you are done, thanks 👍

Learn more about our pull request process.

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

@coderabbitai coderabbitai[bot] coderabbitai[bot] left review comments

@frenck frenck frenck requested changes

Requested changes must be addressed to merge this pull request.

Assignees
No one assigned
Labels
current This PR goes into the current branch
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@jackjourneyman @frenck