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

Improve the OpenRPC Playground code to provide better dev docs #1387

Open
lyonsil opened this issue Dec 11, 2024 · 0 comments
Open

Improve the OpenRPC Playground code to provide better dev docs #1387

lyonsil opened this issue Dec 11, 2024 · 0 comments

Comments

@lyonsil
Copy link
Member

lyonsil commented Dec 11, 2024

https://github.com/open-rpc/playground

Here are some ideas after working on the initial implementation of dev docs:

  • Text wraparound and alignment problems in the tables when things don't fit into a single line
  • "Websocket" dropdown still visible despite "uiSchema[appBar][ui:transports]=false" in the URL which should hide it
  • JSON-RPC message creation always defaults to "id" of 0, This should pick something random (number or string fine)
  • Websocket connection indicator UI doesn't change when the connection is broken, making it look like you're still connected
  • If a schema reference in the OpenRPC doc points to a 3rd party site, the whole UI breaks without any clear errors in the editor view
  • The Playground repo is on Node 14 and has lots of errors/warnings about dependencies with security problems and deprecated versions
  • There are some existing, open issues that would be nice to fix. For example, Support OpenRPC Spec 1.3.2 in Playground open-rpc/playground#606
  • URL fields should be clickable URLs, not just plain text
@lyonsil lyonsil added this to Paranext Dec 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: No status
Development

No branches or pull requests

1 participant