Skip to content

Commit

Permalink
[Ready for Review] Reworking Rules docs (#1860)
Browse files Browse the repository at this point in the history
* Getting started

Signed-off-by: Richard Koshak <rlkoshak@gmail.com>

* [Rules] Add Rules Concepts page

This covers 1 and 1a of the table at
#1855.

Signed-off-by: Florian Hotze <florianh_dev@icloud.com>

* Address @rkoshak 's review

Signed-off-by: Florian Hotze <florianh_dev@icloud.com>

* Address @rkoshak 's review

Signed-off-by: Florian Hotze <florianh_dev@icloud.com>

* Address @rkoshak 's review

Signed-off-by: Florian Hotze <florianh_dev@icloud.com>

* [Rules] Add concept docs for triggers

Signed-off-by: Florian Hotze <florianh_dev@icloud.com>

* [Rules] Add concepts docs for conditions

Signed-off-by: Florian Hotze <florianh_dev@icloud.com>

* Address @rkoshak 's review for triggers

Signed-off-by: Florian Hotze <florianh_dev@icloud.com>

* Address @rkoshak 's review for conditions

Signed-off-by: Florian Hotze <florianh_dev@icloud.com>

* Address @rkoshak 's review

Signed-off-by: Florian Hotze <florianh_dev@icloud.com>

* [rules] Add remaining sections of concepts page

Signed-off-by: Florian Hotze <florianh_dev@icloud.com>

* Add note about "Scenes" to rules concepts

Signed-off-by: Florian Hotze <florianh_dev@icloud.com>

* [Rules Concepts] Add Scripts and Script Actions sections

Signed-off-by: Florian Hotze <florianh_dev@icloud.com>

* [Rule Concepts] Add Available Values, Rule Templates & Helper Libraries sections

Signed-off-by: Florian Hotze <florianh_dev@icloud.com>

* [Rules Concepts] Add comprehensive examples with JS Scripting code snippets

Signed-off-by: Florian Hotze <florianh_dev@icloud.com>

* [Rules Concepts] Add DSL code to comprehensive examples

Signed-off-by: Florian Hotze <florianh_dev@icloud.com>

* [Rules Concepts] Add UI rule code to comprehensive examples

Signed-off-by: Florian Hotze <florianh_dev@icloud.com>

* [Rules Concepts] Add UI rule screenshots to examples

Signed-off-by: Florian Hotze <florianh_dev@icloud.com>

* Address @rkoshak 's review

Signed-off-by: Florian Hotze <florianh_dev@icloud.com>

* [Rules Concepts] Add JRuby examples from @rkoshak

Signed-off-by: Florian Hotze <florianh_dev@icloud.com>

* [Rules Concepts] Link to the JRuby Scripting addon

Signed-off-by: Florian Hotze <florianh_dev@icloud.com>

* Update docs-sidebar.js

Added the new rules concepts page to the sidebar.

Signed-off-by: Rich Koshak <rlkoshak@gmail.com>

* Addressing MD Linting

Signed-off-by: Richard Koshak <rlkoshak@gmail.com>

* Removing files we are not ready to push to upstream

Signed-off-by: Richard Koshak <rlkoshak@gmail.com>

* Removing files we are not ready to push to upstream

Signed-off-by: Richard Koshak <rlkoshak@gmail.com>

* Removing files we are not yet ready to push upstream

Signed-off-by: Richard Koshak <rlkoshak@gmail.com>

* Deleting files not ready to push to upstream

Signed-off-by: Richard Koshak <rlkoshak@gmail.com>

* Removing files not ready to push to upstream

Signed-off-by: Richard Koshak <rlkoshak@gmail.com>

* Removing files not ready to push to upstream

* Removing files not ready to push to upstream

Signed-off-by: Richard Koshak <rlkoshak@gmail.com>

* Moved new rules concepts page to the concepts folder.

Signed-off-by: Richard Koshak <rlkoshak@gmail.com>

* Fixed paths to images

Signed-off-by: Richard Koshak <rlkoshak@gmail.com>

* Attempting to fix tabs for examples

Signed-off-by: Richard Koshak <rlkoshak@gmail.com>

* Fixing tabs for last two examples, cleaning for consistency

Signed-off-by: Richard Koshak <rlkoshak@gmail.com>

* Fix old gh pages syntax

Signed-off-by: Jerome Luckenbach <github@luckenba.ch>

Signed-off-by: Richard Koshak <rlkoshak@gmail.com>
Signed-off-by: Florian Hotze <florianh_dev@icloud.com>
Signed-off-by: Rich Koshak <rlkoshak@gmail.com>
Signed-off-by: Jerome Luckenbach <github@luckenba.ch>
Co-authored-by: Florian Hotze <florianh_dev@icloud.com>
Co-authored-by: Jerome Luckenbach <email@jerome-luckenbach.de>
  • Loading branch information
3 people authored Nov 18, 2022
1 parent 2048ca3 commit e92b820
Show file tree
Hide file tree
Showing 9 changed files with 801 additions and 0 deletions.
1 change: 1 addition & 0 deletions .vuepress/docs-sidebar.js
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,7 @@ module.exports = [
'concepts/discovery',
'concepts/audio',
'concepts/units-of-measurement',
'concepts/rules',
]
},
{
Expand Down
Binary file added concepts/images/rule-arrival.jpeg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added concepts/images/rule-leaving.jpeg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added concepts/images/rule-openwindow-action.jpeg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added concepts/images/rule-openwindow.jpeg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added concepts/images/rule-scene.jpeg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added concepts/images/rule-sunrise-trigger.jpeg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added concepts/images/rule-sunrise.jpeg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
800 changes: 800 additions & 0 deletions concepts/rules.md

Large diffs are not rendered by default.

0 comments on commit e92b820

Please sign in to comment.