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

Add documentation #82

Merged
merged 6 commits into from
Jul 30, 2024
Merged

Add documentation #82

merged 6 commits into from
Jul 30, 2024

Conversation

goanpeca
Copy link
Contributor

@goanpeca goanpeca commented Jul 22, 2024

Fixes #57

README.md

Screenshot 2024-07-29 at 4 53 33 AM

Contributing guide

Screenshot 2024-07-22 at 9 55 21 AM

@goanpeca goanpeca self-assigned this Jul 22, 2024
@goanpeca goanpeca marked this pull request as draft July 22, 2024 14:45
Copy link

codecov bot commented Jul 22, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 92.09%. Comparing base (c48deb2) to head (9df5efa).

Additional details and impacted files
@@           Coverage Diff           @@
##             main      #82   +/-   ##
=======================================
  Coverage   92.09%   92.09%           
=======================================
  Files          10       10           
  Lines        1695     1695           
=======================================
  Hits         1561     1561           
  Misses        134      134           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@goanpeca goanpeca requested review from jaimergp and dalthviz July 29, 2024 09:51
@goanpeca goanpeca marked this pull request as ready for review July 29, 2024 09:51
@goanpeca goanpeca changed the title Add initial docs structure Add documentation Jul 29, 2024
Copy link
Member

@dalthviz dalthviz left a comment

Choose a reason for hiding this comment

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

Thank you for the work here @goanpeca ! Left some suggestions for a couple of misspelling/missing lines to be updated from napari-animation. Also, added a couple comments/questions about commands to install the different dependencies (for development, for testing and for the docs)

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
docs/developers/contributing.md Outdated Show resolved Hide resolved
docs/developers/contributing.md Outdated Show resolved Hide resolved
docs/developers/contributing.md Show resolved Hide resolved
docs/developers/contributing.md Show resolved Hide resolved
@goanpeca
Copy link
Contributor Author

Thanks @dalthviz and @jaimergp for the review and fixes!

Made a couple of small tweaks. Will merge after and prepare the release 🥳

@goanpeca goanpeca merged commit a2d411c into napari:main Jul 30, 2024
12 checks passed
@goanpeca goanpeca deleted the docs branch July 30, 2024 17:14
@psobolewskiPhD
Copy link
Member

I'm sorry I missed this one, thanks a ton y'all!
Looks great! 😊

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add documentation site for napari-plugin-manager
4 participants