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.

Sign up for GitHub

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

Jump to bottom

Add Documentation for Zarr Streaming Library #92

Open
9 of 11 tasks
dgmccart opened this issue Dec 2, 2024 · 1 comment · May be fixed by #93
Open
9 of 11 tasks

Add Documentation for Zarr Streaming Library #92

dgmccart opened this issue Dec 2, 2024 · 1 comment · May be fixed by #93
Assignees
@melissawm

Comments

@dgmccart
Copy link
Collaborator

dgmccart commented Dec 2, 2024 •
edited by melissawm
Loading

The standalone Zarr Streaming library will be incorporated into the existing documentation site.

  • Create a new landing page linked in the top nav bar "Stream to Zarr"
  • Add content described below to the Landing page
  • Set up autogeneration of Python API docs
  • Set up autogeneration of C library docs

Landing Page

  • Page copy: "The Acquire Zarr Streaming library supports chunked, compressed, multiscale streaming to Zarr, with OME-NGFF metadata."
  • Add centered "Get Started" button which links to the README
  • Add 4 tiles
  • Top Left tile: Python API Reference - Information on classes and methods (Link to Python API)
  • Top Right tile: C API Reference - Information on classes and methods (check this phrasing) (Link to C Library API)
  • Bottom Left Tile: Python Tests - Integration tests that demonstrate how to use the python library (Link to python tests)
  • Bottom Right Tile: C Tests - Integration tests that demonstrate how to use the C library (Link to C tests)
@dgmccart
Copy link
Collaborator Author

dgmccart commented Dec 2, 2024 •
edited
Loading

Fallback for both API references is to link to the documentation on Github

@melissawm melissawm linked a pull request Dec 3, 2024 that will close this issue
Draft
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@melissawm melissawm

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Add acquire-zarr docs melissawm/acquire-docs
2 participants
@melissawm @dgmccart