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

Tracking issue for plugin docs update #582

Open
2 of 6 tasks
willingc opened this issue Feb 18, 2025 · 2 comments
Open
2 of 6 tasks

Tracking issue for plugin docs update #582

willingc opened this issue Feb 18, 2025 · 2 comments

Comments

@willingc
Copy link
Contributor

willingc commented Feb 18, 2025

Let's focus a bit on updating plugin docs. This issue contains links to other plugin related documentation requests.

Issues

PRs in other repos

napari/napari-plugin-engine#61 - deprecation info for napari-plugin-engine and migration links to npe2

Rough plan

@willingc
Copy link
Contributor Author

From #223, potentially add:

Plugins are a powerful way to extend the functionality of napari and share these extensions with the community. Plugins facilitate the integration of domain-specific features into napari, while preserving napari as a versatile and domain-agnostic viewer at its core. Existing plugins address a diverse array of challenges, including image segmentation, support for new file formats during reading and writing, single-cell tracking, and animation creation within napari. While scripts and widgets can also be used to extend napari, plugins offer the most convenient method for publicly sharing additional features.

Check out the user focused content to guide you through installing and using napari plugins, or the developer focused content to start creating your own plugins for napari.

Also easily redistributable since a python package.

@willingc
Copy link
Contributor Author

@DragaDoncila @psobolewskiPhD @melissawm Plugin ❤️

melissawm pushed a commit that referenced this issue Feb 21, 2025
Partially addresses #582 

# References and relevant issues
Updates plugin landing page

# Description
Adds additional links and gives reader more context about what is a
plugin.

---------

Co-authored-by: Tim Monko <[email protected]>
DragaDoncila pushed a commit that referenced this issue Feb 27, 2025
# References and relevant issues
Partially addresses #582

# Description
This PR untabs the plugin landing page so a reader can quickly skim info
for plugin users and plugin developers without having to click the tab.
DragaDoncila pushed a commit that referenced this issue Feb 27, 2025
# References and relevant issues
Closes #224.
Addresses #582.

Together with with #581 improves the user's understanding of plugins,
their discovery, and installation.

# Description

This PR simplifies the prose using concepts from [Google's Docs Style
Guide](https://developers.google.com/style/tone#politeness-and-use-of-please)

---------

Co-authored-by: Tim Monko <[email protected]>
Co-authored-by: Peter Sobolewski <[email protected]>
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

No branches or pull requests

1 participant