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

More documentation #227

Open
ivirshup opened this issue Oct 10, 2024 · 1 comment
Open

More documentation #227

ivirshup opened this issue Oct 10, 2024 · 1 comment
Labels
documentation Improvements or additions to documentation

Comments

@ivirshup
Copy link
Contributor

The documentation for this package is currently largely limited to reference docs. There is also a tutorial notebook, but it is mainly a listing of the available methods.

I would recommend adding more explanation and how-to guides, following the diataxis framework.

@ivirshup ivirshup added the documentation Improvements or additions to documentation label Oct 10, 2024
@brianraymor
Copy link

Thanks for sharing the reference. I plan to review. I'd note that the original primary intent for this package was for internal scenarios to enforce consistency - to eliminate duplication of ontology downloads and processing across CELLxGENE experiences. In the past, we've had cases where CELLxGENE applications/services were not using the pinned ontology releases in the schema.

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

2 participants