docs: update documentation to reflect current codebase state#364
Draft
pgfeller wants to merge 1 commit into
Draft
docs: update documentation to reflect current codebase state#364pgfeller wants to merge 1 commit into
pgfeller wants to merge 1 commit into
Conversation
- README.md: remove Paper UI preview feature (removed in v0.8.0) - CHANGELOG.md: add Removed section for openhab.updateNotice (openhab#362); fix typo 'loing' -> 'long' in v1.0.0 entry - CONTRIBUTING.md: update openhab2-addons link to openhab-addons; fix VS Code type definitions path to @types/vscode - docs/USAGE.md: correct openhab.connection.host and openhab.connection.port defaults (null, not openhabianpi/8080); fix keyboard shortcut for settings (Ctrl+, not Ctrl+Shift+S) - .vscode/settings.json: add missing cSpell words (basicui, matchresult, openhabhost) Signed-off-by: Patrik Gfeller <patrik.gfeller@proton.me>
There was a problem hiding this comment.
Pull request overview
Documentation maintenance pass intended to align Markdown docs (and editor spellcheck config) with the current state of the openHAB VS Code extension.
Changes:
- Remove outdated README references to Paper UI and prune unused badge definitions.
- Update usage/contributing docs for configuration defaults, shortcuts, and repo/type-definition paths.
- Extend workspace cSpell dictionary with additional project-specific words.
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 5 comments.
Show a summary per file
| File | Description |
|---|---|
README.md |
Removes Paper UI feature mention and some badge definitions; still contains a typo in the intro sentence. |
docs/USAGE.md |
Updates config default descriptions and the Settings shortcut; defaults currently conflict with effective runtime behavior due to deprecated fallback. |
CONTRIBUTING.md |
Updates add-ons repo link and VS Code typings path; wording still references “openHAB2 addons”. |
CHANGELOG.md |
Adds a “Removed” section for update-notice features, but it does not match the current codebase (features still present). |
.vscode/settings.json |
Adds cSpell words for project terminology. |
| @@ -7,15 +7,12 @@ | |||
|
|
|||
| [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. | |||
Comment on lines
+12
to
14
| - `openhab.connection.host` (mandatory), default: *not set* | ||
| - `openhab.connection.port` (optional), default: *not set* | ||
|
|
| #### 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 3 (with its on default activated api authentication) has been released you have to fullfil some additional steps to get a working connection. |
| @@ -11,7 +11,7 @@ In order to join our forces here, you'd need a few things to get started: | |||
|
|
|||
| Please report [openHAB VS Code Extension specific issues here](https://github.com/openhab/openhab-vscode/issues), | |||
| while issues that are related to *openHAB2 addons* or *openHAB Core* should be reported in the | |||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Routine documentation maintenance pass — bringing all Markdown files in sync with the current codebase. No functional changes.
Changes
README.mdCHANGELOG.md### Removedblock foropenhab.updateNotice(#362); fix typo "loing" → "long" in v1.0.0 entryCONTRIBUTING.mdopenhab2-addonsissue link →openhab-addons; fix VS Code type definitions path (node_modules/vscode/vscode.d.ts→node_modules/@types/vscode/index.d.ts)docs/USAGE.mdopenhab.connection.hostandopenhab.connection.portdefaults (actual default isnull, notopenhabianpi/8080); fix keyboard shortcut for Settings (Ctrl+,notCtrl+Shift+S).vscode/settings.jsonbasicui,matchresult,openhabhost