Skip to content

Add developer documentation to the new docs#144

Merged
BSchilperoort merged 7 commits into
mainfrom
dev_docs_update
Apr 18, 2023
Merged

Add developer documentation to the new docs#144
BSchilperoort merged 7 commits into
mainfrom
dev_docs_update

Conversation

@BSchilperoort

@BSchilperoort BSchilperoort commented Mar 28, 2023

Copy link
Copy Markdown
Member

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/

@BSchilperoort
BSchilperoort marked this pull request as ready for review March 28, 2023 14:33
@BSchilperoort
BSchilperoort requested a review from Peter9192 March 28, 2023 14:35
@codecov

codecov Bot commented Mar 28, 2023

Copy link
Copy Markdown

Codecov Report

Merging #144 (e52e8e7) into main (6c85d09) will not change coverage.
The diff coverage is n/a.

❗ Current head e52e8e7 differs from pull request most recent head 9ca9e96. Consider uploading reports for the commit 9ca9e96 to get more accurate results

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 Peter9192 left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@BSchilperoort

Copy link
Copy Markdown
Member Author

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).

@BSchilperoort
BSchilperoort requested a review from Peter9192 April 5, 2023 13:08
@Peter9192

Copy link
Copy Markdown
Collaborator

Should we also point from CONTRIBUTING.md to the developer docs, and vice versa?

@BSchilperoort

BSchilperoort commented Apr 17, 2023

Copy link
Copy Markdown
Member Author

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 Peter9192 left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's more like what I had expected, good job!

@BSchilperoort
BSchilperoort merged commit fda4717 into main Apr 18, 2023
@BSchilperoort
BSchilperoort deleted the dev_docs_update branch April 18, 2023 07:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants