Skip to content
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

Create hotspot #37140

Draft
wants to merge 2 commits into
base: next
Choose a base branch
from
Draft

Conversation

jkt628
Copy link

@jkt628 jkt628 commented Jan 27, 2025

Proposed change

document changes proposed in home-assistant/cli#533 to create an access point

Type of change

  • Spelling, grammar or other readability improvements (current branch).
  • 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: Create hotspot cli#533
  • 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

    • Updated command line interface documentation
    • Added new command examples for core updates and network configuration
    • Expanded help command output with additional commands
  • New Features

    • Enhanced Home Assistant CLI with more comprehensive command list
    • Added ability to update core to specific version
    • Introduced new network and system management commands

@home-assistant home-assistant bot added current This PR goes into the current branch has-parent This PR has a parent PR in a other repo in-progress This PR/Issue is currently being worked on needs-rebase The PR has been branched of the wrong base branch or targets an incorrect target branch labels Jan 27, 2025
@home-assistant
Copy link

It seems that this PR is targeted against an incorrect branch since it has a parent PR on one of our codebases. Documentation that needs to be updated for an upcoming release should target the next branch. Please change the target branch of this PR to next and rebase if needed.

Copy link

netlify bot commented Jan 27, 2025

Deploy Preview for home-assistant-docs ready!

Name Link
🔨 Latest commit 833d90a
🔍 Latest deploy log https://app.netlify.com/sites/home-assistant-docs/deploys/67a8841e4dc76e0009b2f7f5
😎 Deploy Preview https://deploy-preview-37140--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 site configuration.

Copy link
Contributor

coderabbitai bot commented Jan 27, 2025

📝 Walkthrough

Walkthrough

The pull request updates the Home Assistant command-line interface (CLI) documentation by introducing new commands and expanding the help command output. The changes focus on adding more detailed instructions for core updates, network configuration, and providing a more comprehensive list of available commands. The documentation now includes specific syntax for updating Home Assistant to a precise version and creating a WiFi access point, enhancing user guidance for command-line interactions.

Changes

File Change Summary
source/_includes/common-tasks/commandline.md - Added ha core update --version x.y.z command for specific version updates
- Introduced ha network update for WiFi access point configuration
- Expanded ha help output with new commands: available-updates, completion, mounts, refresh-updates, security, and store

Sequence Diagram

sequenceDiagram
    participant User
    participant CLI as Home Assistant CLI
    participant Core as Home Assistant Core
    participant Network as Network Configuration

    User->>CLI: ha core update --version x.y.z
    CLI->>Core: Request specific version update
    Core-->>CLI: Update confirmation

    User->>CLI: ha network update
    CLI->>Network: Configure WiFi access point
    Network-->>CLI: Configuration status
Loading

📜 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 c1c7e48 and 14bdf43.

📒 Files selected for processing (1)
  • source/_includes/common-tasks/commandline.md (3 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • source/_includes/common-tasks/commandline.md

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:

  • 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. (Beta)
  • @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.

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: 2

🧹 Nitpick comments (3)
source/_includes/common-tasks/commandline.md (3)

Line range hint 47-57: Add version compatibility warning.

Consider adding a note about version compatibility to prevent users from accidentally downgrading or skipping major versions. This helps users avoid potential breaking changes or migration issues.

Add this warning after the example:

Replace x.y.z with the desired version like `--version {{current_version}}`

+ > **Important:** It's recommended to update only to the next available version to ensure compatibility. Skipping versions may lead to migration issues.

64-65: Enhance band and channel documentation.

The current description of band and channel options is incomplete and could be more informative.

Add more detailed information:

-band='bg' # for 2.4GHz, 'a' for 5GHz, more later with 802.11ax and 802.11be
-channel=5 # typically 1-14 for 'bg', 32-177 for 'a'
+band='bg' # Options: 'bg' (2.4GHz), 'a' (5GHz), 'ax' (WiFi 6), 'be' (WiFi 7, where supported)
+channel=5 # Channel ranges: 1-14 (2.4GHz/'bg'), 36-165 (5GHz/'a'), check local regulations

87-112: Consider grouping related commands in the help output.

The command list would be more user-friendly if organized into logical groups with headers.

Consider reorganizing the commands into categories like:

Available Commands:
  System Management:
    core              Provides control of the Home Assistant Core
    supervisor        Monitor, control and configure the Home Assistant Supervisor
    host             Control the host/system that Home Assistant is running on
    
  Network & Security:
    network          Network specific for updating, info and configuration imports
    dns             Get information, update or configure the Home Assistant DNS server
    security        Get information and manage security functionality
    
  Updates & Maintenance:
    available-updates  Provides information about current pending updates
    refresh-updates    Reload stores and version information
    backups           Create, restore and remove backups
    
  [Additional categories...]
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between cb2cb6c and 1f23064.

📒 Files selected for processing (1)
  • source/_includes/common-tasks/commandline.md (3 hunks)

source/_includes/common-tasks/commandline.md Outdated Show resolved Hide resolved
source/_includes/common-tasks/commandline.md Outdated Show resolved Hide resolved
@jkt628
Copy link
Author

jkt628 commented Feb 3, 2025

i built HAOS with changes from home-assistant/supervisor#5577 and home-assistant/cli#533 and was able to actually test this on rpi4b. the command worked with one small tweak so i fixed, squashed my commits, and rebased next.

i will hold this Ready for review until the other PRs merge and i can test with official image.

@jkt628 jkt628 force-pushed the feat/ipv4-method-shared branch 2 times, most recently from 513099a to a6c7774 Compare February 7, 2025 12:34
@jkt628 jkt628 force-pushed the feat/ipv4-method-shared branch from a6c7774 to 833d90a Compare February 9, 2025 10:31
@jkt628
Copy link
Author

jkt628 commented Feb 9, 2025

requires home-assistant/operating-system#3865

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
has-parent This PR has a parent PR in a other repo in-progress This PR/Issue is currently being worked on next This PR goes into the next branch
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants