Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Untab the plugin users and plugin developers grids #593

Merged
merged 6 commits into from
Feb 27, 2025

Conversation

willingc
Copy link
Contributor

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.

@github-actions github-actions bot added the documentation Improvements or additions to documentation label Feb 22, 2025
@psobolewskiPhD
Copy link
Member

psobolewskiPhD commented Feb 23, 2025

Hmm, I dunno about this one.
I don't think there are a lot of people who are new and interested in both?
I expect the progression to typically be newcomer -> plugin user -> advanced user -> plugin developer.
I don't want to create cognitive load for a new comer.

That's my initial thought anyways--not a blocker, will sleep on it.

@TimMonko
Copy link
Contributor

Personally, I like untabbing because the information is already not so dense and it brings forward a strength of napari: how integrated being a plugin user and being a potential plugin developer can be. One other progression (that I think I see amongst many plugin developers) is advanced bioimage user (ie fiji/imagej, cellprofiler) -> desire to share resources with others -> see how easy that can be in napari -> become plugin developer almost before being a napari user.

But, also ok if we don't change.

@willingc
Copy link
Contributor Author

There's no rush to do this right now. Let's get the docs build stable and we can noodle more on this. There are definitely pros/cons to untabbing.

@psobolewskiPhD
Copy link
Member

psobolewskiPhD commented Feb 26, 2025

Hmmm...

/home/circleci/project/venv/lib/python3.10/site-packages/numpydoc/docscrape.py:421: UserWarning: Unknown section Events in the docstring of LayerList in /home/circleci/project/napari/napari/components/layerlist.py.

and we have warnings as fails.
That section of the docstring is not new, so I guess with the dependency group we have a different version of something that is resulting in the warning?

Edit: No, that's not it, this run (which passed) has that line too:
https://github.com/napari/docs/actions/runs/13533769826/job/37821500336

I dunno, I can't find it. We really need to fix the _status_bar spam, which I think is due to threading.

@willingc
Copy link
Contributor Author

@psobolewskiPhD Let me rebase and see if that solves it.

@melissawm
Copy link
Member

The actual failure is this one:

/home/circleci/project/docs/docs/plugins/index.md:23: ERROR: Invalid directive argument: argument must be 1 or 4 (xs sm md lg) values, and each value should be either auto or an integer from 1 to 12

@melissawm
Copy link
Member

melissawm commented Feb 26, 2025

Hmmm...

/home/circleci/project/venv/lib/python3.10/site-packages/numpydoc/docscrape.py:421: UserWarning: Unknown section Events in the docstring of LayerList in /home/circleci/project/napari/napari/components/layerlist.py.

This is a benign warning that doesn't fail the docs build. It comes from the fact that napoleon admits custom sections (which I defined for the Events section of the docstrings) but numpydoc doesn't like when it doesn't recognize a section 😅 Maybe that will change in the future, though.

@psobolewskiPhD
Copy link
Member

@melissawm 🎉 you've got hawk eyes! I was looking for "warning" and things like that, didn't expect "Error" to be the thing.
Hopefully we can get some of the AttributeErrors cleared up with napari/napari#7565 and that will make parsing the build logs much easier.

@melissawm
Copy link
Member

Looking good! https://output.circle-artifacts.com/output/job/403fc564-a523-4a6e-b4a5-29bb5e5665ac/artifacts/0/docs/docs/_build/html/plugins/index.html

Screenshot 2025-02-26 at 2 24 38 PM

I think this is a good compromise - segments the audience without hiding content. I like it!

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.

I'm convinced! looks solid!

@psobolewskiPhD psobolewskiPhD added the enhancement New feature or request label Feb 26, 2025
@psobolewskiPhD psobolewskiPhD added this to the 0.6.0 milestone Feb 26, 2025
@DragaDoncila DragaDoncila merged commit fe7fc3e into napari:main Feb 27, 2025
9 checks passed
@willingc willingc deleted the plugin-landing branch February 27, 2025 23:06
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants