Update contributing docs page #715
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
github-actions
bot
added
the
documentation
|
Interesting, so Circle isn't running at all anymore? Gah! |
|
@napari-bot make slimfast |
|
Very wierd. The comment triggered a run, but it's marked as triggered by Juan and from main: |
|
|
||
| ````{dropdown} napari gallery of examples only |
There was a problem hiding this comment.
this one isn't strictly true, the docs will be built, just no notebook cells run. Not sure how best to communicate that.
Based on the first two, I I guess I suggest:
Suggested change
| ````{dropdown} napari gallery of examples only | |
| ````{dropdown} napari/docs and napari gallery of examples |
|
|
||
| ````{dropdown} Single example in the gallery |
There was a problem hiding this comment.
Based on the logic above, but I dont love it.
Suggested change
| ````{dropdown} Single example in the gallery | |
| ````{dropdown} napari/docs and a single example in the gallery |
psobolewskiPhD
approved these changes
May 22, 2025
willingc
approved these changes
May 24, 2025
| @@ -1,10 +1,34 @@ | |||
| (contributing-docs)= | |||
| # Contributing Documentation | |||
|
|
|||
| This guide will teach you how to submit new documents to napari's usage | |||
| documentation. | |||
| This guide will teach you how to submit your contributions to napari's documentation. | |||
There was a problem hiding this comment.
Suggested change
| This guide will teach you how to submit your contributions to napari's documentation. | |
| This guide will teach you how to contribute to napari's documentation. |
|
|
||
| ## Organization of the documentation | ||
| In general, contributing requires: |
There was a problem hiding this comment.
Suggested change
| In general, contributing requires: | |
| To begin contributing, you will need: |
| - Some familiarity with [`git`](https://git-scm.com). | ||
| - A [GitHub](https://github.com) account. | ||
|
|
||
| There are two ways you can approach your contribution: |
There was a problem hiding this comment.
Suggested change
| There are two ways you can approach your contribution: | |
| Choose an approach to contributing: |
| changes _before_ submitting them. This approach requires a local setup of the | ||
| napari and docs repositories. | ||
|
|
||
| ## Before you start |
There was a problem hiding this comment.
Suggested change
| ## Before you start | |
| ## Ask for guidance |
Comment on lines
+24
to
+29
| If you'd like to contribute a brand new document to our usage section, it might | ||
| be worth [opening an issue](https://github.com/napari/docs/issues/new/choose) | ||
| on our repository first to discuss the content you'd like to see and get some | ||
| early feedback from the community. The napari team can also suggest what type of | ||
| document would be best suited, and whether there are already existing documents | ||
| that could be expanded to include the content you think is lacking. |
There was a problem hiding this comment.
Suggested change
| If you'd like to contribute a brand new document to our usage section, it might | |
| be worth [opening an issue](https://github.com/napari/docs/issues/new/choose) | |
| on our repository first to discuss the content you'd like to see and get some | |
| early feedback from the community. The napari team can also suggest what type of | |
| document would be best suited, and whether there are already existing documents | |
| that could be expanded to include the content you think is lacking. | |
| If you'd like to contribute a brand new document to our usage section, it's | |
| worth [opening an issue](https://github.com/napari/docs/issues/new/choose) | |
| on our repository to discuss the content you'd like to see and get some | |
| early feedback from the community. The napari team can also suggest what type of | |
| document would be best suited, and whether there are already existing documents | |
| that could be expanded to include your proposed content. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
References and relevant issues
--
Description
This is a suggestion only, and I took a heavy axe to this document 😅 But I just wanted to experiment with a different organization of things. I tried:
This can obviously be very subjective so I'm definitely happy to address feedback and keep working on it. In particular I'll come back tomorrow to review the links and other internal references since they might have changed.
The main content is still all there, I just moved things around and maybe reworded things here and there.