Skip to content

PyImageJ Documentation Revitalization #333

@hinerm

Description

@hinerm

I decided to start one parent issue for documentation which can be updated with other documentation improvements.

Things I've noticed:

  • The Troubleshooting notebook is not in sync with the Troubleshooting page
  • Integration doesn't mention napari-imagej
  • Initialization --> "with more memory" feels like it is contradicting the "configuring the JVM". Clarify when to use one or the other.
  • Make the "Ways to initialize" table fit without horizontal scrollbars
  • "Tutorial notebooks" would benefit from an "open in colab" option/better interactivity. Is there a way to embed in RTD?
  • Blob detection (interactive) uses napari??
  • "Troubleshooting -> Common Errors" would benefit from separation of scope (user, developer)
  • Some examples do not use reproducible initialization
  • Update examples to not use wsr.imagej.net
  • 6.2 is broken?
  • All the Ops stuff is ImageJ Ops and should probably be removed
  • https://py.imagej.net/en/latest/Cellpose-StarDist-Segmentation.html needs work (version pins)
  • Improve headless instructions with subprocess.Popen(["Xvfb", ":99", "-screen", "0", "1024x768x24"]) and a clearer explanation of when headless mode is really needed
  • All installation instructions need to be updated to use uv

Related issues:

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions