DOC Update doc contributing guide #5114
Conversation
|
Click here to download the docs artifacts |
|
Click here to download the docs artifacts |
|
Click here to download the docs artifacts |
Codecov Report
@@ Coverage Diff @@
## main #5114 +/- ##
=======================================
Coverage 87.62% 87.62%
=======================================
Files 587 587
Lines 50049 50053 +4
=======================================
+ Hits 43854 43859 +5
+ Misses 6195 6194 -1
Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. |
lucyleeow
changed the title
| If your documentation change includes code, it is important that you ensure | ||
| the code is working and executable. This is why you will need to have a | ||
| development installation of napari installed. [Examples](..../examples/README) |
There was a problem hiding this comment.
I hope this makes sense. We just need them to check that their code works right? It is not otherwise executed as part of doc build?
|
Click here to download the docs artifacts |
|
Click here to download the docs artifacts |
|
Click here to download the docs artifacts |
|
Click here to download the docs artifacts |
|
Click here to download the docs artifacts |
|
Click here to download the docs artifacts |
There was a problem hiding this comment.
I made just some small comments. I think it would be nice if people who just wanted to add their document via the github interface had an early exit from this document. Where you let them know they don't need to update the TOC I would just tell them to skip past previewing & running their code and just say "Open your PR and a member of the maintenance team will help with updating TOC & making sure docs build correctly. You'll also be able to preview this doc from a link posted on your PR". Or something like that
|
|
||
| ## 1. Download our template | ||
| Fork and clone [our repository](https://github.com/napari/napari). If you are | ||
| a0mending existing documentation, you can do so in your preferred text editor. |
There was a problem hiding this comment.
| a0mending existing documentation, you can do so in your preferred text editor. | |
| amending existing documentation, you can do so in your preferred text editor. |
| ## 3. Update TOC | ||
| * If you are amending an existing document you can skip straight | ||
| to [Step #3 - Preview your document](#3-preview-your-document) | ||
| * If you are adding new documentation and would prefer a simplier workflow, |
There was a problem hiding this comment.
| * If you are adding new documentation and would prefer a simplier workflow, | |
| * If you are adding new documentation and would prefer a simpler workflow, |
Good suggestion. I have updated but happy to amend? |
|
Click here to download the docs artifacts |
|
Thanks! |
Czaki
added
the
triaged-0.4.18
Description
As discussed in a recent working group meeting:
Type of change
References
How has this been tested?
as there are small differences between the two Qt bindings.
Final checklist:
trans.to make them localizable.For more information see our translations guide.