Skip to content

Update partner docs URLs to BMZ-specific pages#254

Open
oeway wants to merge 1 commit intobioimage-io:mainfrom
oeway:update-partner-docs-urls
Open

Update partner docs URLs to BMZ-specific pages#254
oeway wants to merge 1 commit intobioimage-io:mainfrom
oeway:update-partner-docs-urls

Conversation

@oeway
Copy link
Contributor

@oeway oeway commented Feb 13, 2026

Summary

The docs field for each partner is now displayed as a clickable link on the model detail page in the BioImage Model Zoo website (see bioimage-io/bioimage.io@bdbbcb1). This PR updates three partners to point to more specific, BMZ-related documentation pages instead of generic homepages.

Changes

Partner Before After
DeepImageJ github.com/deepimagej/deepimagej-plugin/wiki deepimagej.github.io/ (main docs site with tutorials)
BiaPy biapy.readthedocs.io/ biapy.readthedocs.io/en/latest/get_started/bmz.html (dedicated BMZ guide)
QuPath qupath.readthedocs.io/ qupath.readthedocs.io/en/latest/docs/deep/bioimage.html (BMZ integration page)

Request to partner maintainers

The docs URL for each partner is now shown to users as a documentation link next to the software name in the Compatibilities panel on each model's detail page. This helps users learn how to install and use your software with BioImage Model Zoo models.

Could you please review the docs URL for your partner entry and consider:

  1. Does your current docs URL point to a page that helps users get started with BioImage Model Zoo models in your software?
  2. If not, could you create a dedicated guide page (e.g., "How to use BioImage Model Zoo models in [your software]") and update the docs URL to point there?

Ideally each partner would have a page that covers:

  • How to install the software
  • How to load/import a model from the BioImage Model Zoo
  • A quick example of running a BMZ model

cc @esgomezm @k-dominik @danifranco @maweigert @jansanrom @ElpadoCan

🤖 Generated with Claude Code
via Happy

Updated docs links for partners where more specific BMZ-related
documentation pages exist:

- deepimagej: point to deepimagej.github.io (main site with tutorials)
  instead of the GitHub wiki
- biapy: point to the dedicated BMZ integration guide at
  biapy.readthedocs.io/en/latest/get_started/bmz.html
- qupath: point to the BMZ-specific page at
  qupath.readthedocs.io/en/latest/docs/deep/bioimage.html

Generated with [Claude Code](https://claude.ai/code)
via [Happy](https://happy.engineering)

Co-Authored-By: Claude <noreply@anthropic.com>
Co-Authored-By: Happy <yesreply@happy.engineering>
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.

1 participant