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 Documentation #1

Open
pcbowers opened this issue Apr 5, 2022 · 4 comments
Open

Improve Documentation #1

pcbowers opened this issue Apr 5, 2022 · 4 comments
Labels
documentation Improvements or additions to documentation

Comments

@pcbowers
Copy link
Owner

pcbowers commented Apr 5, 2022

Currently, all documentation is found within the README. Ideally, a GitHub pages website or something similar would be created to provide better docs for this plugin.

@pcbowers pcbowers added the documentation Improvements or additions to documentation label Apr 5, 2022
@pcbowers
Copy link
Owner Author

The difficult with documentation is the current part system that sanity uses and its lack of support with third-party documentation systems. With the advent of sanity v3, this should be fixed due to the deprecation of parts and introduction of a better API. However, this may require a complete rewrite and breaking version change due to the support of sanity v3 instead of v2.

@marcodallagatta
Copy link

@pcbowers I also noticed that on the Sanity plugin page https://www.sanity.io/plugins/tags it still shows a v2 warning.

@toddpadwick
Copy link

contrary to the sanity plugin page, is this plugin reliable and well maintained for V3 now? or should I avoid it for the time being?

@marcodallagatta
Copy link

marcodallagatta commented Nov 25, 2023

contrary to the sanity plugin page, is this plugin reliable and well maintained for V3 now? or should I avoid it for the time being?

I have been using it for a couple of weeks, and it seems to work great.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

3 participants