-
Notifications
You must be signed in to change notification settings - Fork 30
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
add plugin quickstart docs page #446
Conversation
Fixes #464 |
…ethods (#473) * initialize model components with None * improve tests; small fix in GridModel.write * update changelog
* remove deprecated dependency group and associated code * update chagnelog
Thanks for giving this a good start @savente93 ! I now wrote what I hope should be quite a complete guide on how to develop a plugin. It does quote some parts of the dev guide but I thought nice for users to have everything (with links!) in one place. We discussed that there is not enough figures in our docs so I added 2 of them. If they are not nice or clear we can remove or adapt. The powerpoint version is in our sharepoint. Maybe @DirkEilander you would like to have a look before merging? Else it is now good for me. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for this huge effort and great contribution @savente93 and @hboisgon
- I've made one PR for the cookiecutter (which I believe has already been merged)
- The docs contain an amazing level of detail and information. I'm really happy you took the time to write this down. I think it could still benefit from some restructuring though by 1) moving some general aspects to elsewhere in model section of the user guide; and 2) splitting it into basic and advanced topics
- Some conventions would be good to discuss, see specific comments below.
- A lot of the comments are simple typos, you can select these and commit in a batch commit.
Co-authored-by: DirkEilander <[email protected]>
@hboisgon I tried to take care of as many issues as I could but there are a couple of comments that I'm not sure how to respond to. Could you take another look please? |
@DirkEilander I've resolved your comments as best I could and also done some light editing. Could you take another look? |
Thanks @savente93! I've done a final check and happy for it to be merged. |
Issue addressed
Fixes #375
Explanation
This PR should be reviewed together with https://github.com/savente93/hydromt-plugin-template. Currently the docs are still lacking a bit, but a good start has been made.
Checklist
main
Additional Notes (optional)
Add any additional notes or information that may be helpful.