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.

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

DOCS: Add base config path for addon to docs #351

Closed
wants to merge 1 commit into from
Closed

DOCS: Add base config path for addon to docs #351

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions appdaemon/DOCS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,8 @@ this isn't needed.

## Configuration

Configurations are under `/addon_configs/a0d7b954_appdaemon`
Copy link
Member

Choose a reason for hiding this comment

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

This doesn't have to be the case. The add-on simply requests a configuration folder (forks, and different stability channels will generate different folders).

That said, this is not an a specific thing for this add-on, but generic Home Assistnat logic and functionality.

../Frenck

<br/><br/>
Comment on lines +33 to +34
Copy link

Choose a reason for hiding this comment

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

⚠️ Potential issue

Clarify configuration file path and improve formatting

Thank you for adding information about the configuration location. However, there are a few points that need to be addressed:

  1. The path you've added (/addon_configs/a0d7b954_appdaemon) differs from the path mentioned in the PR description (/config/appdaemon.yaml). Can you please verify the correct path?

  2. The configuration file name (appdaemon.yaml) is not mentioned. It would be helpful to include this information.

  3. The note about restarting the add-on is important and could be made more prominent.

I suggest revising this section as follows:

## Configuration

The AppDaemon configuration file (`appdaemon.yaml`) should be located at `/config/appdaemon.yaml`.

**Important:** Remember to restart the add-on when the configuration is changed.

Example add-on configuration:

This revision:

  • Specifies the configuration file name and its exact path
  • Makes the restart note more prominent
  • Maintains the existing structure of the document

Please verify the correct path and update accordingly. If the path /addon_configs/a0d7b954_appdaemon is indeed correct, please clarify why it differs from the path mentioned in the PR description and add-on logs.

**Note**: _Remember to restart the add-on when the configuration is changed._

Example add-on configuration:
Expand Down