Skip to content

Conversation

@sarah-hlsn
Copy link
Collaborator

@sarah-hlsn sarah-hlsn commented Nov 20, 2023

Changes proposed in this PR:

  • added overview of which software to use for what to the climada installation guide
  • edited the developer guide for easier accessibility for new developers

This PR fixes #800

PR Author Checklist

PR Reviewer Checklist

@chahank chahank requested a review from viggowat November 20, 2023 09:14
Copy link
Collaborator

@leonie-villiger leonie-villiger left a comment

Choose a reason for hiding this comment

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

Thank you for restructuring the guides for the sake of readability! I appreciate having more, but shorter guides (e.g., exception_logging in a guide on its own).

The only guide that is still a bit hard to digest - in my opinion - is the Guide_Git_Development. No adaptations requested there, but a point to discuss. Besides that I found some sentences that need corrections (and some typos that I directly corrected, see my two commits) before the branch can be merged with develop.

sarah-hlsn and others added 6 commits November 28, 2023 08:09
Co-authored-by: leonie-villiger <87335708+leonie-villiger@users.noreply.github.com>
Co-authored-by: viggowat <86475542+viggowat@users.noreply.github.com>
Co-authored-by: leonie-villiger <87335708+leonie-villiger@users.noreply.github.com>
Co-authored-by: viggowat <86475542+viggowat@users.noreply.github.com>
@sarah-hlsn sarah-hlsn marked this pull request as ready for review December 6, 2023 10:39
Copy link
Member

@peanutfun peanutfun left a comment

Choose a reason for hiding this comment

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

This is coming along very nicely. Thank you for the effort! I am a bit nitpicky so I still found some issues I would like to discuss or have changed 😁

In general, I found a lot of broken links. Some just don't have an effect, some are not even rendered anymore. These should all come up as warnings when building the documentation locally. Could you give it another look? I did not mention all in my comments.

@sarah-hlsn
Copy link
Collaborator Author

@peanutfun I've now made all the changes we've discussed so feel free to merge once you are happy!

@peanutfun
Copy link
Member

@sarah-hlsn I added more information on coverage in f210c72

@peanutfun
Copy link
Member

feel free to merge once you are happy!

@sarah-hlsn Sorry, I missed that 😅 Will do!

@peanutfun
Copy link
Member

Excellent work, @sarah-hlsn! Thanks a lot!

Merging now...

@peanutfun peanutfun merged commit d022094 into develop Jan 25, 2024
@emanuel-schmid emanuel-schmid deleted the overview_developer_guide branch March 13, 2024 15:05
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.

6 participants