-
-
Notifications
You must be signed in to change notification settings - Fork 1k
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
Update tutorial.md - local directory #2592
base: master
Are you sure you want to change the base?
Conversation
more info on where to store the local addons
📝 WalkthroughWalkthroughThe update revises the tutorial documentation for add-on development. It changes the directory creation instruction so that users now create the directory inside the Changes
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. 🪧 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 (
|
There was a problem hiding this 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)
docs/add-ons/tutorial.md (1)
21-22
: Improve clarity on add-on directory placement
The updated instruction now clearly states that users should create the new directory inside theaddons/local
directory, which aligns with the PR objective of clarifying the location for local add-ons. One suggestion is to cross-reference the earlier explanation (at line 9) that mentions the shared folder "addons" to clarify the relationship betweenaddons
andaddons/local
(for example, explaining thataddons/local
is the designated subdirectory for custom/local add-ons).
@@ -18,7 +18,7 @@ Once you have located your add-on directory, it's time to get started! | |||
|
|||
## Step 1: The basics | |||
|
|||
- Create a new directory called `hello_world` | |||
- Create a new directory called `hello_world` (inside the `addons/local` directory) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
That sounds incorrect? As per the paragraph above, the correct folder for that is /addons
.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
yes, I think it's incorrect to create the directory in addons/hello_world
in my fresh install from last week I have the following directories after HA install :
addons/core (contains all standard addons)
addons/data (contains some data)
addons/local (empty in a fresh install)
My guess is that in the new HA versions it has changed and the custom addons have to be placed in the local/ directory.
I followed the tutorial creating the addons/local/hello_world
directory and all was good.
I must say I did not even try to create the directory as addons/hello_world
Please take a look at the requested changes, and use the Ready for review button when you are done, thanks 👍 |
more info on where to store the local addons
Proposed change
Type of change
Additional information
Summary by CodeRabbit