Migrate and update hub customization from wiki to docs by TimMonko · Pull Request #906 · napari/docs

TimMonko · 2026-01-13T06:15:45Z

References and relevant issues

Description

Adds to docs and COMPLETELY REHAULS (so pls check carefully)https://github.com/chanzuckerberg/napari-hub/wiki/Customizing-your-plugin's-listing
- uses pyproject instead of setup.cfg
- uses newer project config metadata
- clarifies differences in how metadata is acquired
- doesn't really update the table (I had an LLM convert it), but I'm not really sure how important this is to have?
Also converts a smaller idea about descriptions from https://github.com/chanzuckerberg/napari-hub/wiki/Writing-the-Perfect-Description-for-your-Plugin
adds to Plugins -> Testing and publishing. Is this the appropriate place, or should it be in Building a Plugin?
Updates section in deploy to reference this new file

TimMonko · 2026-01-13T06:16:41Z

@jni since you requested this in napari/napari-plugin-template#128, pls review 😉 🙏
@DragaDoncila this is the conversion from the wiki we talked about, is there any other files that would be good here and an easy win? Or even just others I should think more about converting over in follow up PRs?

docs/plugins/testing_and_publishing/hub_customization.md

DragaDoncila

@TimMonko so much great information here ❤️ A lot of it can be removed now that we're not using the .napari-hub/ folder and because we still are missing a lot of features on hub-lite 😭 I've left comments where appropriate.

docs/plugins/testing_and_publishing/deploy.md

docs/plugins/testing_and_publishing/hub_customization.md

DragaDoncila · 2026-01-27T08:20:52Z

docs/plugins/testing_and_publishing/hub_customization.md

+
+## Field reference
+
+This table summarizes where each field is displayed and how it's sourced:


Not sure how useful this table still is tbh. Everything comes from PyPI or manifest. Maybe it's worth editing down, but I'd also be happy to just remove it for now.

docs/plugins/testing_and_publishing/hub_customization.md

DragaDoncila · 2026-01-27T08:21:56Z

docs/plugins/testing_and_publishing/hub_customization.md

+- ❌ It won't appear on the napari hub
+- ❌ It won't be automatically discovered by napari
+
+If you want your plugin to remain installable with the napari plugin manager but not appear in search, use the `visibility: hidden` setting in your `napari.yaml` manifest instead.


Can be removed.

docs/plugins/testing_and_publishing/hub_customization.md

Co-authored-by: Draga Doncila Pop <17995243+DragaDoncila@users.noreply.github.com>

TimMonko

Ok, oops, I just kinda went through all @DragaDoncila 's review and did one big massive commit. I think I have 1 or 2 things to address still, but thank you for the review and reminder to do this. Slipped my mind.

I need to look up the image thing for sure.

docs/plugins/testing_and_publishing/hub_customization.md

TimMonko · 2026-01-27T22:30:16Z

docs/plugins/testing_and_publishing/hub_customization.md

+
+### Categories
+
+Categories help users discover your plugin through filtering and search. The hub maps certain npe2 categories to "Workflow Steps":


then what is it for? I was definitely interpolating or it was in the wiki docs
Are Categories used for anything?

TimMonko · 2026-01-27T22:32:55Z

docs/plugins/testing_and_publishing/hub_customization.md

+
+```toml
+[project.urls]
+Homepage = "https://github.com/username/napari-example-plugin"


I guess I'm not understanding this section https://github.com/chanzuckerberg/napari-hub/wiki/Customizing-your-plugin's-listing#project-site? Is it mostly just hopeful then? I know pypi uses these, I guess

TimMonko · 2026-01-28T04:51:24Z

Ok, now with instructions on how to get images and assets to render in READMEs :) This will certainly help me going forward, it's something I've wanted to figure out for a long time. This PR is greatly simplified now, about half as many LOC, so sorry that its a complete reorg. Should be an easier review now!

docs/plugins/testing_and_publishing/hub_customization.md

DragaDoncila · 2026-01-28T06:52:35Z

docs/plugins/testing_and_publishing/hub_customization.md

+
+```toml
+[project.urls]
+Homepage = "https://github.com/username/napari-example-plugin"


@TimMonko on the original implementation of the hub, each of these had their own dedicated field, similar to how it's displayed on pypi. Currently we only link to pypi and github. I'd be open to adding these back to the hub, although there has previously been philosophical discussion on how much information we should duplicate from e.g. pypi -- is the goal to provide all the same information + more, or is the goal to provide basic information + napari-specific stuff. I lean more towards the latter, but would be open to the former.

docs/plugins/testing_and_publishing/hub_customization.md

DragaDoncila · 2026-01-28T07:15:22Z

then what is it for? I was definitely interpolating or it was in the wiki docs
Are Categories used for anything?

Currently sadly, no. They need to be displayed on hub. I've added an issue on hub-lite (and opened a couple of others prompted by this PR), and I've triaged all the open issues using the critical and desired tags, to give us an idea of the work that still needs doing before we can consider the hub somehow "feature complete" - though of course, there are always more improvements to make.

Co-authored-by: Draga Doncila Pop <17995243+DragaDoncila@users.noreply.github.com>

DragaDoncila

@TimMonko two small comments and I think this will be ready to go!

DragaDoncila · 2026-02-12T08:52:16Z

docs/plugins/testing_and_publishing/hub_customization.md

+
+```toml
+[project]
+license = "BSD-3-Clause"


maybe this example should be the license-expression example, since that's the latest way to do it?

DragaDoncila · 2026-02-12T08:54:04Z

docs/plugins/testing_and_publishing/hub_customization.md

+
+```toml
+[project.urls]
+Homepage = "https://github.com/username/napari-example-plugin"


@TimMonko until we resolve napari/hub-lite#4, let's tweak this section to say we display pypi project link and Homepage/Source Code link (whichever one points to GitHub)

TimMonko added 3 commits January 13, 2026 00:02

add hub customization document

a1b2e4c

add to toc and index cards

476ae48

add effective description

b30f4ac

github-actions bot assigned TimMonko Jan 13, 2026

github-actions bot added the documentation Improvements or additions to documentation label Jan 13, 2026

TimMonko added this to the 0.7.0 milestone Jan 13, 2026

TimMonko commented Jan 13, 2026

View reviewed changes

docs/plugins/testing_and_publishing/hub_customization.md Outdated Show resolved Hide resolved

Update docs/plugins/testing_and_publishing/hub_customization.md

1cae297

DragaDoncila reviewed Jan 27, 2026

View reviewed changes

TimMonko and others added 2 commits January 27, 2026 11:36

Merge branch 'main' into feat/hub-customization

3e9ba35

Update responding to Draga's feedback

bb254c8

Co-authored-by: Draga Doncila Pop <17995243+DragaDoncila@users.noreply.github.com>

TimMonko commented Jan 27, 2026

View reviewed changes

TimMonko added 3 commits January 27, 2026 21:37

reorg and simplify

6554c07

split out description and simplify overall again

9c334a8

add info about adding images and other assets

e4e4d17

TimMonko mentioned this pull request Jan 28, 2026

Use raw link for image in README ndev-kit/ndev-themes#3

Merged

remove irrelevant github mention

6ec8104

DragaDoncila reviewed Jan 28, 2026

View reviewed changes

Apply suggestions from code review

75e0f8d

Co-authored-by: Draga Doncila Pop <17995243+DragaDoncila@users.noreply.github.com>

DragaDoncila reviewed Feb 12, 2026

View reviewed changes

Merge branch 'main' into feat/hub-customization

14ea69f


		## Field reference

		This table summarizes where each field is displayed and how it's sourced:


		### Categories

		Categories help users discover your plugin through filtering and search. The hub maps certain npe2 categories to "Workflow Steps":

Conversation

TimMonko commented Jan 13, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

References and relevant issues

Description

Uh oh!

TimMonko commented Jan 13, 2026

Uh oh!

Uh oh!

DragaDoncila left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

DragaDoncila Jan 27, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

DragaDoncila Jan 27, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

TimMonko left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

TimMonko Jan 27, 2026

Choose a reason for hiding this comment

Uh oh!

TimMonko Jan 27, 2026

Choose a reason for hiding this comment

Uh oh!

TimMonko commented Jan 28, 2026

Uh oh!

Uh oh!

DragaDoncila Jan 28, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

DragaDoncila commented Jan 28, 2026

Uh oh!

DragaDoncila left a comment

Choose a reason for hiding this comment

Uh oh!

DragaDoncila Feb 12, 2026

Choose a reason for hiding this comment

Uh oh!

DragaDoncila Feb 12, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

TimMonko commented Jan 13, 2026 •

edited

Loading