8000 Add cards to the Advanced Topics landing page for plugins by willingc · Pull Request #603 · napari/docs · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

Add cards to the Advanced Topics landing page for plugins #603

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.

Sign up for GitHub

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 i 8000 n to your account

Jump to bottom
Merged
merged 5 commits into from
Mar 5, 2025
Merged

Add cards to the Advanced Topics landing page for plugins #603

merged 5 commits into from
Mar 5, 2025

Conversation

willingc
Copy link
Contributor
@willingc willingc commented Feb 28, 2025 •
edited
Loading

References and relevant issues

Partially addresses #600 by improving the Advanced Topics landing page.

Description

This PR adds cards to guide the reader to the npe2 specification. It also more clearly indicates that napari plugin engine v1 is deprecated.

@DragaDoncila @melissawm @psobolewskiPhD FYI

@github-actions github-actions bot added the documentation Improvements or additions to documentation label Feb 28, 2025
@willingc
Copy link
Contributor Author

Rendered page

image

@TimMonko
Copy link
Contributor
TimMonko commented Feb 28, 2025 •
edited
Loading

Looks great! Would it make more sense to move the migration card to the npe1 section?

Basically, I'm thinking that card encourages migration, so that migration card should be to it's right

Thinking it can move too because npe2 has been out for a while now

@willingc
Copy link
Contributor Author

Looks great! Would it make more sense to move the migration card to the npe1 section?

Great suggestion @TimMonko. Updating PR.

@psobolewskiPhD
Copy link
Member

I agree with Tim that the migration should be "under the fold" so to speak, but the side-by-side looks wierd:
image

I think either we should try a different layout or maybe break the 2nd paragraph out of the tile and have it under the header?

@willingc
Copy link
Contributor Author
willingc commented Mar 1, 2025

Let me noodle on this a bit more since I'm not fully happy with the deprecated section.

@psobolewskiPhD
Copy link
Member
psobolewskiPhD commented Mar 1, 2025 •
edited
Loading

What about an admonition above the two npe1 tiles? with New plugins should use ...

@psobolewskiPhD
Copy link
Member

I dig it:
image

Also: whoops I disabled actions when trying to show Tim on Zulip!

psobolewskiPhD
psobolewskiPhD reviewed Mar 2, 2025
View reviewed changes
psobolewskiPhD
psobolewskiPhD approved these changes Mar 2, 2025
View reviewed changes
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.

small nitpick, but otherwise good to go I think

@willingc @psobolewskiPhD
Update admonition
03b89b5 
Co-authored-by: Peter Sobolewski <76622105+psobolewskiPhD@users.noreply.github.com>
@TimMonko
Copy link
Contributor
TimMonko commented Mar 4, 2025

Love where this got to! The admonition is a great solution

@DragaDoncila DragaDoncila added this to the 0.6.0 milestone Mar 5, 2025
DragaDoncila
DragaDoncila approved these changes Mar 5, 2025
View reviewed changes
Copy link
Contributor
@DragaDoncila DragaDoncila left a comment

Choose a reason for hiding this comment

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

Looks awesome, thanks @willingc!

@DragaDoncila DragaDoncila merged commit deccb65 into napari:main Mar 5, 2025
9 checks passed
TimMonko pushed a commit to TimMonko/docs that referenced this pull request Mar 9, 2025
@willingc @psobolewskiPhD @TimMonko
Add cards to the Advanced Topics landing page for plugins (napari#603)
4950e95 
# References and relevant issues
Partially addresses napari#600 by improving the Advanced Topics landing page.

# Description
This PR adds cards to guide the reader to the npe2 specification. It
also more clearly indicates that napari plugin engine v1 is deprecated.
---------

Co-authored-by: Peter Sobolewski <76622105+psobolewskiPhD@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@psobolewskiPhD psobolewskiPhD psobolewskiPhD approved these changes

@DragaDoncila DragaDoncila DragaDoncila approved these changes

@TimMonko TimMonko TimMonko approved these changes

Assignees

@willingc willingc

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
0.6.0
Development

Successfully merging this pull request may close these issues.
4 participants
@willingc @TimMonko @psobolewskiPhD @DragaDoncila
0