[developer-documentation] Add description of tools and utilities - #2605
Conversation
Signed-off-by: Andrew Fiddian-Green <software@whitebear.ch>
✅ Thanks for your pull request to the openHAB documentation! The result can be previewed at the URL below (this comment and the preview will be updated if you add more commits).
To edit notification comments on pull requests, go to your Netlify project configuration. |
Signed-off-by: Andrew Fiddian-Green <software@whitebear.ch>
andrewfg
changed the title
|
Thanks @andrewfg very much appreciated! I can't select copilot to review, but from what i see it seems pretty solid already. Just some markdown issues: Error: developers/utils/tools.md:88:1 MD029/ol-prefix Ordered list item prefix [Expected: 1; Actual: 2; Style: 1/1/1] |
Signed-off-by: Andrew Fiddian-Green <software@whitebear.ch>
|
This pull request has been mentioned on openHAB Community. There might be relevant details there: https://community.openhab.org/t/translating-thing-s-property-names/167417/1 |
|
Documentation like this is very useful 👍 |
|
@andrewfg thanks for taking the effort to document this. LGTM. |
florian-h05
added
the
stat: dependency 💥
|
@andrewfg When do I know if this should be merged? Should we keep this as draft for the time being? |
@stefan-hoehn I wrote this primarily as documentation of my PR openhab/openhab-core#4995 for the Lighting Model .. so the direct answer to your question is that we must wait for that to be merged. And sadly it seems there is nobody interested to review it.. However this PR includes some 'gratis' documentation of the other tools, so if you are in a hurry for that, I guess we could split this PR into two parts -- namely openhab/openhab-core#4995 specific resp. not. |
@stefan-hoehn the PR on which this had depended is now merged, so we can proceed with this one too. |
florian-h05
removed
the
stat: dependency 💥
florian-h05
left a comment
florian-h05
left a comment
There was a problem hiding this comment.
Apart from two comments looks good, thanks!
Co-authored-by: Florian Hotze <dev@florianhotze.com> Signed-off-by: Andrew Fiddian-Green <software@whitebear.ch>
Co-authored-by: Florian Hotze <dev@florianhotze.com> Signed-off-by: Andrew Fiddian-Green <software@whitebear.ch>
Signed-off-by: Florian Hotze <dev@florianhotze.com>
florian-h05
left a comment
florian-h05
left a comment
There was a problem hiding this comment.
LGTM, thanks!
Somehow, my comments weren't applied correctly, so I applied them manually.
8 participants
The reviewer (@lsiepel) of my PR openhab/openhab-core#4995 suggested to add more documentation to describe the new light model feature.
While writing this additional documentation, I realised that there are many other utilities in the openHAB framework which are also not documented. So I added some rudimentary chapters for those too.
Perhaps I can make this into a CALL TO ACTION to other @openhab/core-maintainers and @openhab/add-ons-maintainers that you may also consider to add further documentation for utilities that are not yet described.
Signed-off-by: Andrew Fiddian-Green software@whitebear.ch