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

DOC: Enhanced Quickstart documentation #2865

Open
wants to merge 9 commits into
base: main
Choose a base branch
from

Conversation

arkdong
Copy link
Contributor

@arkdong arkdong commented Feb 25, 2025

Enhanced the information existed on Quickstart documentation page, as mentioned in #1208.

TODO:

  • Add unit tests and/or doctests in docstrings
  • Add docstrings and API docs for any new/modified user-facing classes and functions
  • New/modified features documented in docs/user-guide/*.rst
  • Changes documented as a new file in changes/
  • GitHub Actions have all passed
  • Test coverage is 100% (Codecov passes)

@arkdong
Copy link
Contributor Author

arkdong commented Mar 18, 2025

Hi @d-v-b and @jhamman, I've resolve your suggestion with the text and the relative links. I was unaware that the previous url links that I copied from the README.md in zarr-python repo was belonging to V2 docs, so I change them to sections links of where I think are appropriate from V3 docs. I will open a issue to fix the README.md.

One extra thing, the part of Parallel computing and synchronization in Optimizing performance was showing "Coming soon.". Does this indicate that the docs is not yet written, or that the functionality of parallel computing for V3 is not yet complete.

From "Main Features are" to "Zarr's core features"

Co-authored-by: Davis Bennett <[email protected]>
@arkdong
Copy link
Contributor Author

arkdong commented Mar 18, 2025

Hi @d-v-b, do you know why some test are failed?

@d-v-b
Copy link
Contributor

d-v-b commented Mar 18, 2025

@arkdong not sure, the failed test is potentially flaky. I will re-run the tests, but since your changes are just in the docs I don't think we should worry too much about failing library tests

One extra thing, the part of Parallel computing and synchronization in Optimizing performance was showing "Coming soon.". Does this indicate that the docs is not yet written, or that the functionality of parallel computing for V3 is not yet complete.

IMO that "coming soon" message is not very helpful. Our recommendations for parallel computing and synchronization have not been written yet. That that content will mostly be descriptions of how to integrate zarr with external distributed computing / synchronization libraries, since we don't have any internal tools for distributed computing or synchronization at this time.

@arkdong
Copy link
Contributor Author

arkdong commented Mar 18, 2025

@d-v-b does V3 has relatively same functionality/name for parallel computing part compare to V2?

If it is similar, we can use the part from tutorial.rst in branch support/v2

@d-v-b
Copy link
Contributor

d-v-b commented Mar 18, 2025

@arkdong I don't think we can simply re-use the old v2 docs on parallel computing or synchronization, because we removed some of the APIs mentioned in those docs. Those APIs were useful but we haven't added them to v3 yet.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
needs release notes Automatically applied to PRs which haven't added release notes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants