-
Notifications
You must be signed in to change notification settings - Fork 39
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
For this repo, link contributions to documentation contribution guide #366
Conversation
…ntribution page, rather than main repo contribution guide
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 catching that!
Small tweak, we want the contributing stuff to point to the most current, dev
, version of the docs, rather than stable. At some point this will magically be the case, but for now...
thanks @psobolewskiPhD Co-authored-by: Peter Sobolewski <[email protected]>
I updated your OP to link to this issue: This PR partially addresses it, but doesn't quite close -- unless we think we don't need a summary of the docs contribution stuff in the README... |
Thanks for linking this @psobolewskiPhD , especially as I'm just learning about napari recently and haven't looked around yet at the tickets. I'm happy to update this but I want to confirm I understand what you'd like added... Do you mean the main README should include a (quite) brief-ened (for lack of a better word) version of the guide to contributing to the docs, as well as a quick installation, i.e. what you reference here:
? If so, I'm happy to take a crack at that in this PR :) |
Yea, exactly. If you want to go for that and close that issue, awesome. I think I would lean to the 2nd approach, just to keep things simple. |
Agreed @psobolewskiPhD , I can address #265 in a separate PR :) |
Awesome! Thanks for your efforts! |
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.
LGTM, thanks!
Thank you @vreuter! |
Right now, the "contributing" section of the main README links to the contribution guide for the main project rather than for the documentation itself. This updates the link to point to the contribution guide for the napari documentation.
Partially adresses: #265