Skip to content
This repository has been archived by the owner on May 23, 2019. It is now read-only.

Add proper documentation #159

Merged
merged 2 commits into from
Apr 7, 2017
Merged

Add proper documentation #159

merged 2 commits into from
Apr 7, 2017

Conversation

ghys
Copy link
Member

@ghys ghys commented Mar 8, 2017

See #138.

Signed-off-by: Yannick Schaus habpanel@schaus.net

See openhab#138.

Signed-off-by: Yannick Schaus <habpanel@schaus.net>
@kaikreuzer
Copy link
Member

Hey @ghys, this looks excellent - what keeps you away from merging it?

@ghys
Copy link
Member Author

ghys commented Apr 6, 2017

@kaikreuzer I had the ambition to write a whole chapter about custom widgets and template development before merging it but never got around to it ;) But yes, baby steps, it's quite useable in this state already, and I suppose a link to the relevant new section on community.openhab.org is enough for now. So I'll just made a few corrections and merge it.
@ThomDietrich could you have a look too?

Signed-off-by: Yannick Schaus <habpanel@schaus.net>
@ghys ghys merged commit 8b0d9a4 into openhab:master Apr 7, 2017
@ThomDietrich
Copy link
Member

Totally missed that request... :-/ Had a look now and must say, that's an excellent article ;)
What's the next step, do you want merge with and/or replace http://docs.openhab.org/addons/uis/habpanel/readme.html or is the article supposed to stay independent?

@ghys
Copy link
Member Author

ghys commented Apr 13, 2017

@ThomDietrich my intent was to keep them independent, i.e. leave the readme.html article as it is (for a general description of the addon, similar to those of the other GUIs) and have this more extensive documentation elsewhere in the tree - perhaps under 'Configuration'?
It should link properly to the other parts of the documentation (I hope), I tried to imitate other articles and put {base} in the URLs.

If it's more convenient, I can submit a PR to the openhab-docs repo.

@ThomDietrich
Copy link
Member

Sure thing, makes total sense 👍 let's replicate the configuration article to docs and link it to a menu entry in parallel to http://docs.openhab.org/configuration/paperui.html

PR welcome. ;)

ghys added a commit to ghys/openhab-docs that referenced this pull request Apr 18, 2017
This adds a new article describing HABPanel in more detail
in the Configuration section of the user manual.

As discussed in:
openhab/org.openhab.ui.habpanel#159

Signed-off-by: Yannick Schaus <habpanel@schaus.net>
@ghys ghys modified the milestone: 2.1.0 Jun 28, 2017
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants