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

docs: demo page and viewer template #36

Closed
cpvalente opened this issue May 17, 2024 · 1 comment
Closed

docs: demo page and viewer template #36

cpvalente opened this issue May 17, 2024 · 1 comment

Comments

@cpvalente
Copy link
Owner

Until v3, we have maintained a separate repo viewer-template to teach users how to get the data from the ontime websocket server.

Meanwhile we have created a demo page, which is shipped with Ontime and already has some basic code for managing the connection
https://github.com/cpvalente/ontime/blob/master/apps/server/src/external/demo/app.js

The documentation has lagged behind and we need to update

  • create documentation for demo page
  • remove links to the old viewer-template
  • update event-data page (currently missing auxiliary timer data)

Once users find about the demo page we can investigate whether the solution is clear enough or we should reconsider
Perhaps some users would like to advise on this

@cpvalente
Copy link
Owner Author

Closing this as it turns out that the auxiliary timer is already documented in runtime data.
The other tasks are accounted for and closed with #51

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

1 participant