Plugin refactor [docs]: Rewrite README: update install, usage, workflows#181
Open
C-Achard wants to merge 5 commits intocy/feature-refactor-2026from
Open
Plugin refactor [docs]: Rewrite README: update install, usage, workflows#181C-Achard wants to merge 5 commits intocy/feature-refactor-2026from
C-Achard wants to merge 5 commits intocy/feature-refactor-2026from
Conversation
Overhaul README to improve onboarding and standalone use of napari-deeplabcut. Adds header image, reorganizes installation (pip/uv, dev install, pre-commit), clarifies usage, saving behavior, video support, and labeling/refinement workflows with tips and shortcuts. Updates links, badges, the workflow flowchart, and contributor instructions. Updates license reference to LGPL-3.0 and refines wording throughout for clarity.
C-Achard
added
documentation
21 tasks
C-Achard
changed the base branch from
cy/refactor-2026-cleanup2
to
cy/feature-refactor-2026
Contributor
There was a problem hiding this comment.
Pull request overview
Updates the repository README to reflect the refactored napari-deeplabcut plugin workflow, including revised installation guidance and expanded standalone usage documentation.
Changes:
- Refreshes installation instructions (pip/uv, dev install) and updates key external documentation links.
- Rewrites usage, saving behavior, tools/shortcuts, video support, and standalone workflow guidance.
- Expands contributing guidance (tox + pre-commit) and modernizes license/issues/acknowledgements sections.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
deruyter92
approved these changes
Apr 8, 2026
Collaborator
deruyter92
left a comment
deruyter92
left a comment
There was a problem hiding this comment.
Perfect! Super clear instructions and concrete guidance. I like how you also made clear what the assumtions the standard behavior are (e.g. that the h5 is currently the authorative file).
Just a few minor suggestions, feel free to adjust/adopt/reject according to your own judgement/
Clarified installation instructions and added an example for creating and activating a uv virtual environment (using Python 3.12) before installing with uv. Small wording tweaks: note that pip example is shown e.g. for a conda environment, and the widget auto-open phrasing was made clearer. Added guidance about config.yaml: several plugin functions expect the config two folders up from saved CollectedData files, fallback behavior exists but you will be prompted to provide a matching config if it is missing; the plugin will then save points/metadata into the correct folder based on that config. Recommended moving the dataset into the project structure and updating paths in config.yaml for full compatibility.
Replace the tests badge URL in README.md to point to the new GitHub Actions workflow (test_and_deploy.yml) and include branch=main in the badge URL so the status reflects the correct workflow/branch.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Overhaul README
As part of the full refactor, this update the README to more accurately reflect the updated workflow.
While most of it remains unchanged in terms of usage in general, this update ensures more precise wording and mentions the newest additions where relevant.