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

Store Documentation update #976

Merged
merged 5 commits into from
Jul 1, 2024
Merged

Conversation

rkingsbury
Copy link
Collaborator

@rkingsbury rkingsbury commented Jul 1, 2024

Summary

Overhaul some aspects of the Store documentation

  • Add new tutorial page on query syntax, with examples
  • Expand Using Stores page with more examples
  • Add links from the list of Store to the corresponding API docs
  • add AzureBlobStore to the API docs
  • rename getting started to User Guide
  • add a quickstart page at the top level
  • Add new README content from Add content to README; documentation fixups #969 to the docs homepage

@rkingsbury rkingsbury added release:minor docs documentation labels Jul 1, 2024
@rkingsbury
Copy link
Collaborator Author

Closes #702

Copy link

codecov bot commented Jul 1, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 88.76%. Comparing base (5ce1701) to head (d099a1c).
Report is 7 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #976   +/-   ##
=======================================
  Coverage   88.76%   88.76%           
=======================================
  Files          46       46           
  Lines        3979     3979           
=======================================
  Hits         3532     3532           
  Misses        447      447           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@rkingsbury rkingsbury merged commit fe2eb65 into materialsproject:main Jul 1, 2024
9 checks passed
@rkingsbury rkingsbury deleted the docs branch July 1, 2024 21:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant