Metamask OpenRPC Docusaurus Plugin - Deprecated #660
Comments
|
@shanejonas Actually there is an alternative which is to fork and update the docusaurus plugin, do you have any suggestions on what someone might want to add/ fix with the plugin? |
|
Just some thoughts off the top of my head: Right now the 'interactive part only supports The stoplight dep is not ideal, it does render json-schema relatively nicely but its definitely a pain in the butt. swapping it out would be ideal, not sure if theres another similar lib. |
|
The other thing to consider about a fork and update is the rendering of errors and errorGroups https://github.com/open-rpc/tools/blob/main/packages/docs-react/src/Methods/Methods.tsx#L135 In the methods renderer you'll need to merge the error and errorGroups field to render errors |
|
It also has issues with just basic form validation for some inputs. I'll take a look at your v2 generator code and see what that looks like. |
Would be dope to see how that plays out and if you hit issues we can patch things in that area :D |
Uh oh!
There was an error while loading. Please reload this page.
📝 Summary
The
metamask/docusaurusplugin is deprecated from the perspective of the OpenRPC team. Our new OpenRPC ecosystem has received major version updates across all tools. In particular, the generator now uses the latest Gatsby, Material-UI, and React ecosystem. The old Docusaurus plugin cannot be maintained or updated, and the future of OpenRPC relies on features present in these major versions.🔍 Background
metamask/docusauruspluginopen-rpc/generatornow at2.x.x, built on Gatsby, Material-UI, React📚 Links
2.x.x)🤔 Proposal
2.x.x.>= v20.x.x.Alternative Proposal
2.x.x.>= v20.x.x.@shanejonas for suggestions on what you might add or fix
These steps ensure we’re using the latest ecosystem, unlock new features, and reduce maintenance burden.
🚀 Suggested Resolution
package.json(or the CI config) to use:@open-rpc/generator@^2.x.xnode >= 20.x.x(optional)💻 Environment
@open-rpc/generator@2.x.x>= 14.x.x(current)>= 20.x.x📄 Additional Context
Any local-docs concerns have been addressed in the
2.x.xrelease of the generator. If there are further questions or edge cases, please comment below!The text was updated successfully, but these errors were encountered: