Documentation icon indicating copy to clipboard operation
Documentation copied to clipboard

Add UI documentation to website

Open wborn opened this issue 1 year ago • 2 comments

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

wborn avatar Nov 28 '24 14:11 wborn

I've split up this Epic to individual issues that are smaller in size. They do not include all checkboxes given here, but indicate the amount of work left on this.

List of tasks:

  • [ ] https://github.com/openremote/openremote/issues/1606
  • [ ] https://github.com/openremote/openremote/issues/1607
  • [ ] https://github.com/openremote/openremote/issues/1609
  • [ ] https://github.com/openremote/openremote/issues/1610
  • [ ] https://github.com/openremote/openremote/issues/1611
  • [ ] https://github.com/openremote/openremote/issues/1612
  • [ ] https://github.com/openremote/openremote/issues/1613
  • [ ] https://github.com/openremote/openremote/issues/1614
  • [ ] https://github.com/openremote/openremote/issues/1616
  • [ ] https://github.com/openremote/openremote/issues/1617

MartinaeyNL avatar Jan 21 '25 15:01 MartinaeyNL

Removed the UI documentation Epic from the internal projects board. I'll add the issues described above individually instead.

MartinaeyNL avatar Jan 24 '25 09:01 MartinaeyNL