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

Documentation does not include proper plugin name,; needs version warning removed in Sanity Plugin page #191

Open
sarahmattar opened this issue Jun 4, 2024 · 0 comments

Comments

@sarahmattar
Copy link

Hi @joshredwards , I just installed this in a work project and while it works well, there's still a lot of generic boilerplate in the documentation for usage that hasn't been updated for the plugin's usage. I had to dig into the package to find the name of the plugin, as the docs on Sanity and npm still refer to it as myPlugin({}) instead of ContentModelGraph(). On the Sanity plugin page listing, there is still a warning that the plugin is only compatible with Sanity Studio v2, when it has been updated to v3. I'm not sure if that can be changed on your end or if someone from Sanity has to take it off the "not compatible with v3" list. Updating these details will probably boost plugin adoption significantly!

The good news is once I got it working, it made sense of a moderately complex schema for our CMS use case, which uses a pageBuilder style of fragmenting our schemas to be 1:1 with our components. 😃 It shows the entire schema from a high level, but ideally we want to use it for illustrating prospective schema changes in a PR - is this possible?

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