Improved readability of the developer guide #808
Conversation
There was a problem hiding this comment.
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.
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>
There was a problem hiding this comment.
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.
|
@peanutfun I've now made all the changes we've discussed so feel free to merge once you are happy! |
|
@sarah-hlsn I added more information on coverage in f210c72 |
@sarah-hlsn Sorry, I missed that 😅 Will do! |
|
Excellent work, @sarah-hlsn! Thanks a lot! Merging now... |
Changes proposed in this PR:
This PR fixes #800
PR Author Checklist
develop)PR Reviewer Checklist