Skip to content

(docs) get started#246

Merged
lazarusA merged 1 commit intomasterfrom
la/doc_topics
Mar 20, 2026
Merged

(docs) get started#246
lazarusA merged 1 commit intomasterfrom
la/doc_topics

Conversation

@lazarusA
Copy link
Contributor

@lazarusA lazarusA commented Mar 15, 2026

This PR adds:

  • a new section get started with minimal jargon and explicit usage, hopefully is straightforward.
  • a CHANGELOG.md file so that we can minimally document solved issues or new features
  • a CONTRIBUTING.md file to encourage contributions from new users, for now consider it a minimal template.
  • some features on the landing page
  • moved files into different folders and re-arranged the menu into different topics, some are commented out since they are there now as place holders for new additions.

closes #248 #249 #250 #251 😄

@lazarusA lazarusA added the documentation because someone will ask! label Mar 15, 2026
@coveralls
Copy link

Pull Request Test Coverage Report for Build 23116724268

Details

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 82.336%

Totals Coverage Status
Change from base Build 23072019189: 0.0%
Covered Lines: 1403
Relevant Lines: 1704

💛 - Coveralls

@lazarusA
Copy link
Contributor Author

while creating the groups example,

using Zarr

store = Zarr.DirectoryStore("experiment.zarr")
g = zgroup(store, "", Zarr.ZarrFormat(3))

zcreate(Float64, g, "temperature", 100, 100; chunks=(50, 50), fill_value=0.0)
zcreate(Float64, g, "precipitation", 100, 100; chunks=(50, 50), fill_value=0.0)
g

I noticed that if we don't explicitly say zarr_format=3 in zcreate then it defaults to .zarray and .zattrs. I think the version should be inherit from g.

@lazarusA lazarusA requested a review from mkitti March 16, 2026 10:57
@mkitti
Copy link
Member

mkitti commented Mar 16, 2026

Create an issue if you can, please.

@lazarusA
Copy link
Contributor Author

Already done #247 😬

@lazarusA
Copy link
Contributor Author

I will merge this.
There are not real changes to original docs, only the addition of get started which starts putting things into a more organise form.

@lazarusA lazarusA merged commit e142d95 into master Mar 20, 2026
18 checks passed
@lazarusA lazarusA deleted the la/doc_topics branch March 20, 2026 18:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation because someone will ask!

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Get started section

3 participants