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 UI documentation to website #28

Open
5 tasks
wborn opened this issue Nov 28, 2024 · 0 comments
Open
5 tasks

Add UI documentation to website #28

wborn opened this issue Nov 28, 2024 · 0 comments
Assignees

Comments

@wborn
Copy link
Member

wborn commented Nov 28, 2024

It would be nice to have UI component documentation using Storybook on the website.
There is already a PoC for this.

The remaining work includes:

  • Adding documentation for the remaining components
  • Add a task to the Gradle build that generates all the UI documentation
  • The documentation in the PoC currently uses OpenRemote APIs so it requires a running OpenRemote instance. This may cause older documentation to break when there are API changes.
  • The documentation should be made available on the documentation website
  • Preferably when new releases are created the UI documentation is automatically added to the documentation website
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

No branches or pull requests

2 participants