diff --git a/.vuepress/docs-sidebar.js b/.vuepress/docs-sidebar.js index bac6d02e4..ca917d2ee 100644 --- a/.vuepress/docs-sidebar.js +++ b/.vuepress/docs-sidebar.js @@ -135,7 +135,7 @@ module.exports = [ 'developer/governance', { title: 'Javadoc', - path: 'https://next.openhab.org/javadoc/latest/' + path: 'https://openhab.org/javadoc/latest/' } ] }, diff --git a/README.md b/README.md index 4daa85431..5752eca19 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ This repository contains the documentation for openHAB 3.x. -The result is available at [https://next.openhab.org/docs/](https://www.openhab.org/docs/) and [https://next.openhab.org/addons/](https://www.openhab.org/addons/). +The result is available at [https://openhab.org/docs/](https://www.openhab.org/docs/) and [https://openhab.org/addons/](https://www.openhab.org/addons/). ## How it works @@ -17,8 +17,8 @@ We will read about them later. Correct, this is done in the original repository of the add-on. You may want to know how to find the right file in all of those repos? -This is fairly easy: -on most of the documentation pages on https://next.openhab.org/, +This is fairly easy: +on most of the documentation pages on https://openhab.org/, you will find the following link at the bottom, which will point you directly to the file you want to improve. ![Contribution link to a specific page](./images/contribution_link.png) @@ -31,7 +31,7 @@ This happens mostly once a day. Afterwards your change is included in the next b The documentation is a community effort, so everyone is welcome to suggest changes, add new sections and fix bugs. This is done exactly the same way as for the code repositories, simply through pull requests against this repo. When editing a page through the _"Edit this page on GitHub"_ link on the website, you will be given the opportunity to -create a pull request directly from GitHub. +create a pull request directly from GitHub. Please read our [contribution guidelines](CONTRIBUTING.md) and try to follow them as best as you can before submitting a change for review - but don't worry if you don't understand all of them, we will help you to get it right. diff --git a/configuration/multimedia.md b/configuration/multimedia.md index d3a13f471..70aa773c1 100644 --- a/configuration/multimedia.md +++ b/configuration/multimedia.md @@ -9,7 +9,7 @@ title: Multimedia ## Volume -The framework supports some base [functions](https://next.openhab.org/javadoc/latest/org/openhab/core/model/script/actions/audio#method.summary) to control the audio sinks' volume. +The framework supports some base [functions](https://openhab.org/javadoc/latest/org/openhab/core/model/script/actions/audio#method.summary) to control the audio sinks' volume. ### Actions @@ -58,7 +58,7 @@ openhab> openhab:audio stream example.com ### Actions -Alternatively the [`playSound()`](https://next.openhab.org/javadoc/latest/org/openhab/core/model/script/actions/audio#playSound(java.lang.String)) or [`playStream()`](https://next.openhab.org/javadoc/latest/org/openhab/core/model/script/actions/audio#playStream(java.lang.String)) functions can be used in DSL rules: +Alternatively the [`playSound()`](https://openhab.org/javadoc/latest/org/openhab/core/model/script/actions/audio#playSound(java.lang.String)) or [`playStream()`](https://openhab.org/javadoc/latest/org/openhab/core/model/script/actions/audio#playStream(java.lang.String)) functions can be used in DSL rules: - `playSound(String filename)` : plays a sound from the sounds folder to the default sink - `playSound(String filename, PercentType volume)` : plays a sound with the given volume from the sounds folder to the default sink @@ -109,7 +109,7 @@ openhab> openhab:voice say Hello world! ### Actions -Alternatively you can execute such commands within DSL rules by using the [`say()`](https://next.openhab.org/javadoc/latest/org/openhab/core/voice/voicemanager#say(java.lang.String)) function: +Alternatively you can execute such commands within DSL rules by using the [`say()`](https://openhab.org/javadoc/latest/org/openhab/core/voice/voicemanager#say(java.lang.String)) function: ```java say("Hello world!") @@ -151,7 +151,7 @@ openhab> openhab:voice interpret turn on the light The default human language interpreter will be used. In case of interpretation error, the error message will be said using the default voice and default audio sink. -Again, such a command can also be entered within DSL rules (using the [`interpret()`](https://next.openhab.org/javadoc/latest/org/openhab/core/voice/voicemanager#interpret(java.lang.String)) function) +Again, such a command can also be entered within DSL rules (using the [`interpret()`](https://openhab.org/javadoc/latest/org/openhab/core/voice/voicemanager#interpret(java.lang.String)) function) ```java interpret("turn on the light") diff --git a/configuration/rules-dsl.md b/configuration/rules-dsl.md index 7d445bd3c..f709740e9 100644 --- a/configuration/rules-dsl.md +++ b/configuration/rules-dsl.md @@ -395,7 +395,7 @@ There are two ways to discover these methods: - Use the [openHAB VS Code Extension](/docs/configuration/editors.html#editors.html#openhab-vs-code-extension) and the `` key combo to list all the available methods - Look at the JavaDocs for the given type. -For example, the [JavaDoc for HSBType](https://next.openhab.org/javadoc/latest/org/openhab/core/library/types/hsbtype) shows getRed, getBlue, and getGreen methods. +For example, the [JavaDoc for HSBType](https://openhab.org/javadoc/latest/org/openhab/core/library/types/hsbtype) shows getRed, getBlue, and getGreen methods. These methods can be called in Rules-DSL without the "get" part in name as in `(MyColorItem.state as HSBType).red)`. They retrieve the state of MyColorItem and then casts it as HSBType to be able to use the methods associated with the HSBType.