mirror of
https://github.com/home-assistant/developers.home-assistant.git
synced 2025-07-21 08:16:29 +00:00
Change location of integrations documentation (#337)
Changed the location of the integration/platform documentation from source/_components/ to source/_integrations
This commit is contained in:
parent
008d988a4c
commit
1deccdd50a
@ -25,7 +25,7 @@ To test your changes locally, you need to install **Ruby** and its dependencies
|
|||||||
Then you can work on the documentation:
|
Then you can work on the documentation:
|
||||||
|
|
||||||
- Run `bundle exec rake generate` to generate the very first preview. This will take a minute.
|
- Run `bundle exec rake generate` to generate the very first preview. This will take a minute.
|
||||||
- Create/edit/update a page. The integration/platforms documentation is located in `source/_components/`. `source/_docs/` contains the Home Assistant documentation itself.
|
- Create/edit/update a page. The integration/platforms documentation is located in `source/_integrations/`. `source/_docs/` contains the Home Assistant documentation itself.
|
||||||
- Test your changes to home-assistant.io locally: run `bundle exec rake preview` and navigate to [http://127.0.0.1:4000](http://127.0.0.1:4000). While this command is working, any changes to a file are automatically detected and will update the affected pages. You will have to manually reload them in the browser though.
|
- Test your changes to home-assistant.io locally: run `bundle exec rake preview` and navigate to [http://127.0.0.1:4000](http://127.0.0.1:4000). While this command is working, any changes to a file are automatically detected and will update the affected pages. You will have to manually reload them in the browser though.
|
||||||
- Create a Pull Request (PR) against the **next** branch of home-assistant.io if your documentation is a new feature, platform, or integration.
|
- Create a Pull Request (PR) against the **next** branch of home-assistant.io if your documentation is a new feature, platform, or integration.
|
||||||
- Create a Pull Request (PR) against the **current** branch of home-assistant.io if you fix stuff, create Cookbook entries, or expand existing documentation.
|
- Create a Pull Request (PR) against the **current** branch of home-assistant.io if you fix stuff, create Cookbook entries, or expand existing documentation.
|
||||||
|
Loading…
x
Reference in New Issue
Block a user