DOCS: Add base config path for addon to docs #351
Conversation
when it starts it logs `Configuration read from: /config/appdaemon.yaml`
WalkthroughThe pull request introduces a new section in the AppDaemon documentation, specifying the configuration location at Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant AppDaemon
participant Configuration
User->>Configuration: Modify configuration
Configuration->>AppDaemon: Save changes
AppDaemon-->>User: Reminder to restart
User->>AppDaemon: Restart add-on
AppDaemon-->>User: Configuration applied
Poem
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? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
| Configurations are under `/addon_configs/a0d7b954_appdaemon` | ||
| <br/><br/> |
There was a problem hiding this comment.
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:
-
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? -
The configuration file name (
appdaemon.yaml) is not mentioned. It would be helpful to include this information. -
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.
| @@ -30,6 +30,8 @@ this isn't needed. | |||
|
|
|||
| ## Configuration | |||
|
|
|||
| Configurations are under `/addon_configs/a0d7b954_appdaemon` | |||
There was a problem hiding this comment.
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
Proposed Changes
I assumed the appdaemon.yaml was supposed to be under
/config/appdaemon.yamlThe add-on also logs
Configuration read from: /config/appdaemon.yamlwhen it startsSummary by CodeRabbit