docs: fix typos, remove obsolete version references, update add-ons links, and improve accuracy#370
docs: fix typos, remove obsolete version references, update add-ons links, and improve accuracy#370Copilot wants to merge 3 commits into
Conversation
Agent-Logs-Url: https://github.com/openhab/openhab-vscode/sessions/a871769e-d727-46e5-8a71-66df12580de8 Co-authored-by: pgfeller <9395643+pgfeller@users.noreply.github.com>
| #### openHAB Rest API | ||
|
|
||
| Since openHAB 3 (with its on default activated api authentication) has been released you have to fulllfil some additional steps to get a working connection. | ||
| Since openHAB (with its on default activated API authentication) you have to fulfill some additional steps to get a working connection. |
There was a problem hiding this comment.
Formulate differently. Those are not additional steps. Higlight, that the API token is the prefered way to authenticate.
There was a problem hiding this comment.
Rephrased in commit 940e1fa — the section now opens with "API token authentication is the preferred way to connect the extension to openHAB" and frames the steps as setup instructions rather than required extra work.
| Language servers allow you to add your own validation logic to files open in VS Code. | ||
| openHAB from version `openHAB 2.2.0 Build #1065` (SNAPSHOT) has the Language Server exposed on `5007` port. | ||
| openHAB 2.2 since build #1084 has LSP feature enabled in the runtime, so there are no additional steps for you to make it work. | ||
| openHAB has the Language Server exposed on `5007` port. |
There was a problem hiding this comment.
Explain in a short, but concice way that the server exposes a language server on port 5007 by default. Remove the section that explains that no additional configuration is necessary.
There was a problem hiding this comment.
Updated in commit 940e1fa — the section now reads: "The openHAB server exposes a language server on port 5007 by default, which the extension uses for syntax validation and content assist." The "no additional steps" sentence has been removed.
| Although, you can access the Items and Things through the REST API. | ||
| Note that LSP (content assist for rules and syntax validation) won't be exposed, so you'll need to disable it too. | ||
|
|
||
| The following configuration will allow you to access REST API remotely: |
There was a problem hiding this comment.
check known issue #278, and include the workarround - and that a warning will be shownn
There was a problem hiding this comment.
Added in commit 940e1fa — a note block immediately after the remote access config snippet explains that a deprecation warning for openhab.username/openhab.password may appear even without explicitly setting those values, links to issue #278, and gives the workaround (full reinstall of the extension).
| [openHAB](http://www.openhab.org) is a vendor and techology agnostic open source automation software for your home. This [Visual Studio Code](https://code.visualstudio.com) extension allows you to work with openHAB configuration files (like `*.items`, `*.rules`, `*.sitemap` and `*.script`) thanks to the syntax highlighting, code snippets and integrated search. | ||
|
|
||
| The extension is designed with openHAB 2.x in mind - most snippets and design patterns will work in openHAB 2.x | ||
| [openHAB](http://www.openhab.org) is a vendor and technology agnostic open source automation software for your home. This [Visual Studio Code](https://code.visualstudio.com) extension allows you to work with openHAB configuration files (like `*.items`, `*.rules`, `*.sitemap` and `*.script`) thanks to the syntax highlighting, code snippets and integrated search. |
There was a problem hiding this comment.
Check the source code for limitations - as this is not supported for all languages.
There was a problem hiding this comment.
Updated in commit 940e1fa — the intro now lists all six supported file types explicitly: *.items, *.rules, *.sitemap, *.script, *.things, *.persist (matching the languages entry in package.json and the documentSelector in LocalLanguageClientProvider.ts), removing the "like … and" framing that implied an incomplete list.
Agent-Logs-Url: https://github.com/openhab/openhab-vscode/sessions/ab06c974-438f-4ba7-a86f-a434a0c66ed1 Co-authored-by: pgfeller <9395643+pgfeller@users.noreply.github.com>
Addresses unresolved review comments from PR #364 and applies the additional instruction to strip obsolete openHAB version numbers throughout the docs. Also improves accuracy and completeness based on reviewer feedback.
Changes
README.md
techology→technologyopenHAB2 code snippets→openHAB code snippets*.items,*.rules,*.sitemap,*.script,*.things,*.persistdocs/USAGE.md
openHAB 3 Rest API→openHAB Rest APIfulllfil→fulfill,api→APISince openHAB 3 (…) has been released→Since openHAB (…)openHAB 2.2.0 Build #1065,openHAB 2.2 since build #1084)5007by default; removed "no additional steps" sentenceCONTRIBUTING.md
openHAB2 addons→openHAB add-onsopenHAB2 GitHub repository/openhab2-addons→openHAB add-ons GitHub repository/openhab-addons