Refactor and Simplify Documentation

JuliaDataCubes / YAXArrays.jl

Yet Another XArray-like Julia package

https://juliadatacubes.github.io/YAXArrays.jl/

Other

89 stars 12 forks source link

Refactor and Simplify Documentation #395

Closed danlooo closed 1 month ago

danlooo commented 1 month ago

This PR aims to make the documentation more readable and consistent. Everything from the old documentation is migrated to here if they are not redundant.

One page per task, e.g. read or write. Group all file formats into one page
Add explanation about the data types, e.g. Array vs Cube
Add page on how to convert between other types: e.g. Raster
Add example on how to read ArchGDAL
Add example on mapCube that modifies input and output dimensions (i.e. lat and lon to region)
Consistent naming of arrays and datasets
Simplify get started: Only 2 lines of code to the first YAXArray

Please feel free to comment on further improvements to make this package as easy to use as possible.

coveralls commented 1 month ago

Pull Request Test Coverage Report for Build 9209944563

Warning: This coverage report may be inaccurate.

This pull request's base commit is no longer the HEAD commit of its target branch. This means it includes changes from outside the original pull request, including, potentially, unrelated coverage changes.

For more information on this, see Tracking coverage changes with pull request builds.
To avoid this issue with future PRs, see these Recommended CI Configurations.
For a quick fix, rebase this PR at GitHub. Your next report should be accurate.

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 68.231%

Totals
Change from base Build 8923844786:	0.0%
Covered Lines:	1207
Relevant Lines:	1769

💛 - Coveralls

codecov[bot] commented 1 month ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 68.15%. Comparing base (a287107) to head (778f635). Report is 3 commits behind head on master.

Additional details and impacted files

```diff @@ Coverage Diff @@ ## master #395 +/- ## ======================================= Coverage 68.15% 68.15% ======================================= Files 12 12 Lines 1771 1771 ======================================= Hits 1207 1207 Misses 564 564 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

lazarusA commented 1 month ago

the etc folder needs a better name. Remember, the file structure will gives the actual final path to the resource. Hence, descriptive names are preferred. Edit: ohh, it looks like a temporal edit TODO.

danlooo commented 1 month ago

That's right. Its my working dir for stuff that is not integrated yet. I'll yet you know once this draft PR is ready

danlooo commented 1 month ago

I'm done for my side with migrating the entire documentation to a consistent structure. Fell free to comment and merge @meggart @lazarusA @felixcremer