Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add generated component reference #864

Merged
merged 5 commits into from Feb 5, 2021
Merged

Conversation

ghys
Copy link
Member

@ghys ghys commented Jan 29, 2021

First version of script
Add System Library, Standard Library

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

First version of script
Add System Library, Standard Library

Signed-off-by: Yannick Schaus <github@schaus.net>
@ghys ghys requested a review from a team as a code owner January 29, 2021 18:55
Signed-off-by: Yannick Schaus <github@schaus.net>
Declare files as assets/definitions as modules with
package.json for NodeJS.

Reuse existing generated docs if existing and find specially-formatted
comments in Markdown for inserting the autogenerated content.

Signed-off-by: Yannick Schaus <github@schaus.net>
Signed-off-by: Yannick Schaus <github@schaus.net>
Signed-off-by: Yannick Schaus <github@schaus.net>
@ghys ghys changed the title [WIP] Add generated component reference Add generated component reference Feb 5, 2021
@ghys
Copy link
Member Author

ghys commented Feb 5, 2021

I'll merge the autogenerated stuff which seems to work and try to have them on the website early, and then we can add more documentation in subsequent PRs.

The part between comments like <!-- GENERATED ... --> and <!-- GENERATED /... --> in the articles should not be touched as it is subject to being overwritten when the pages are regenerated.

However what's outside those sections will be preserved.

What I'd like to see in other manually written sections is:

Description

For some components, a more detailed description than the provided generated description is desirable - it can even replace the generated section which is usually only a one-liner.

Inherited Configuration

(below Configuration)
Indication, when applicable, that the configuration will be passed to an underlying component (from Framework7, ECharts, Leaflet...) and either provide a link to their documentation (https://v5.framework7.io, https://echarts.apache.org/en/option.html, https://vue2-leaflet.netlify.app/components/, etc.) or eventually replicate it in the same format as the autogenerated config.

Examples

(last section)
Complete examples of (simple) widgets illustrating how the component can be used, or one of its features - should have a title, a YAML code snippet (ready to parse in Developer Tools > Widgets) and a screenshot/GIF.
Some of these examples can be sourced from the forum.

@ghys ghys merged commit ba4d76f into openhab:main Feb 5, 2021
ghys added a commit to openhab/website that referenced this pull request Feb 5, 2021
Includes:
- openhab/openhab-docs#1464
- openhab/openhab-webui#864

Signed-off-by: Yannick Schaus <github@schaus.net>
@ghys ghys mentioned this pull request Jul 24, 2022
3 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant