Add developer documentation to the new docs#144
Conversation
Codecov Report
Additional details and impacted files@@ Coverage Diff @@
## main #144 +/- ##
=======================================
Coverage 99.66% 99.66%
=======================================
Files 14 14
Lines 596 596
=======================================
Hits 594 594
Misses 2 2 |
Peter9192
left a comment
There was a problem hiding this comment.
Looks nice. Note that there's a considerable overlap with the content of CONTRIBUTING.md now. It would be good to remove specific instructions there (and check for differences!), and replace the content of contributing with something that's more tailored to community contribution workflow. Here is an example of a very short one I condensed recently in a similar work item.
Thanks for the example, I've adapted it slightly for the documentation here. I have also added a code of conduct (was missing). |
|
Should we also point from CONTRIBUTING.md to the developer docs, and vice versa? |
Hm, on second though, there is still some outdated info in there, and it overlaps quite a lot with what is on readthedocs. I decided to move the still-relevant content to the docs, and link to both readthedocs and the relevant source files. Those are markdown files, so should still be readable even if readthedocs is unavailable. |
Peter9192
left a comment
There was a problem hiding this comment.
That's more like what I had expected, good job!
This adds developer documentation. Largely a description of our (hatch) project setup, but also a shorter section on the structure of the era5cli code.
I also added the vector source of the logo. The colors were not added in inkscape, so I do not have a vector image for those.
docs are here https://era5cli--144.org.readthedocs.build/en/144/general_development/