Skip to content
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

Merged
merged 3 commits into from
Mar 7, 2024

Conversation

vreuter
Copy link
Contributor

@vreuter vreuter commented Mar 5, 2024

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

…ntribution page, rather than main repo contribution guide
Copy link
Member

@psobolewskiPhD psobolewskiPhD left a 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...

README.md Outdated Show resolved Hide resolved
@psobolewskiPhD psobolewskiPhD added this to the 0.5.0 milestone Mar 5, 2024
@psobolewskiPhD psobolewskiPhD added enhancement New feature or request maintenance CI, dependencies, and other maintenance labels Mar 5, 2024
README.md Outdated Show resolved Hide resolved
@psobolewskiPhD
Copy link
Member

I updated your OP to link to this issue:
#265

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

@vreuter
Copy link
Contributor Author

vreuter commented Mar 5, 2024

I updated your OP to link to this issue: #265

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:

Additionally, I think it would be helpful to have the install and local make docs instructions as brief bullet points in the README for the advanced user to get going quickly.

?

If so, I'm happy to take a crack at that in this PR :)

@psobolewskiPhD
Copy link
Member

psobolewskiPhD commented Mar 5, 2024

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:

Yea, exactly. If you want to go for that and close that issue, awesome.
Otherwise we can merge this -- it's good to go and un-controvertial -- and you can make a new PR for that, which may require more tweaking. Up to you!

I think I would lean to the 2nd approach, just to keep things simple.

@vreuter
Copy link
Contributor Author

vreuter commented Mar 5, 2024

I think I would lean to the 2nd approach, just to keep things simple.

Agreed @psobolewskiPhD , I can address #265 in a separate PR :)

@psobolewskiPhD
Copy link
Member

Awesome! Thanks for your efforts!
I'll try to remember to merge this tomorrow, just in case there is some additional discussion 👀
If I don't, please feel free to ping me with a reminder.
Also, in case you're interested feel free to reach out on napari.zulipchat.com
Or come to a community meeting: https://napari.org/stable/community/meeting_schedule.html

Copy link
Collaborator

@lucyleeow lucyleeow left a comment

Choose a reason for hiding this comment

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

LGTM, thanks!

@GenevieveBuckley GenevieveBuckley merged commit 26897eb into napari:main Mar 7, 2024
6 checks passed
@GenevieveBuckley
Copy link
Contributor

Thank you @vreuter!

@vreuter vreuter deleted the vr/link-to-docs-docs branch March 7, 2024 13:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request maintenance CI, dependencies, and other maintenance
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants