This repository has been archived by the owner on Aug 21, 2024. It is now read-only.
Attempting to integrate an OpenRPC spec into our docs site #533
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Preview is available here: |
|
Looks like the patch for |
|
Something went wrong with PR preview build please check |
|
Preview is available here: |
|
To see what is happening, I set up a new series of pages that can be found here: https://soroban-docs-pr533.previews.kube001.services.stellar-ops.com/rpc. I'm particularly happy with how the "methods" pages have turned out, like this one: https://soroban-docs-pr533.previews.kube001.services.stellar-ops.com/rpc/methods/getEvents |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This required a bit of fiddling, configuring, and customizing some packages. Hopefully, it all builds and compiles OK 🤞🏻
Essentially, I've made an
openrpc.jsonspec for the Soroban-RPC specification to live within. This is then used to generate the RPC pages, using the@metamask/docusaurus-openrpcpackage. I've swizzzled the method page from that package into a theme file for our own customizations. I've also included a patch to the@metamask/open-rpc-docs-reactpackage that will remove any irrelevant stuff about ethereum, and include a better code examples section.