Plugin refactor [docs]: Add v0.3.0.0 release notes and images#195
Merged
C-Achard merged 11 commits intoMay 4, 2026
Conversation
Add release notes for v0.3.0.0 (docs/release_notes/v0_3_0_0.md) describing a near-complete plugin rewrite, safety and debugging improvements, UI and workflow changes, data loading/saving fixes, and other quality-of-life and code-quality updates. Include accompanying images used by the notes (status_panel, color_scheme_skip, traj_plot, tutorial, shortcuts, debug, new_menu, and others) under docs/release_notes/imgs/v_0_3_0_0/.
C-Achard
added
documentation
26 tasks
Add notes about a minimal deprecation system and new debug contexts for performance monitoring and automated log generation. Also add a link to issue #184 for refactor discussion, adjust final wording, and apply minor formatting/whitespace fixes in the drag-&-drop and closing paragraphs.
deruyter92
approved these changes
Apr 30, 2026
deruyter92
left a comment
deruyter92
left a comment
Collaborator
There was a problem hiding this comment.
Looks amazing! Comprehensive user-focused list!
Introduce default_stages and explicitly assign stages to hooks, marking safe checks as pre-commit/manual and file-modifying hooks as pre-commit-only. Add check-merge-conflict, set name-tests-test args, and ensure end-of-file-fixer/trailing-whitespace run only in pre-commit. Bump pyproject-fmt to v2.21.1 and update ruff pre-commit to v0.15.12, replacing the previous ruff entries with a clear split: local autofix/format hooks (pre-commit) and CI check-only variants (manual) with appropriate args. Remove the napari-plugin-checks entry and reorganize hooks for clearer local vs CI behavior.
C-Achard
changed the base branch from
cy/v0.3.0.0-version-bump
to
cy/feature-refactor-2026
C-Achard
added a commit
that referenced
this pull request
Apr 30, 2026
Plugin refactor : full version User patch notes available [here(#195).
Revise docs/release_notes/v0_3_0_0.md to clarify plugin behavior and improve wording. Reword the intro to highlight safety improvements around data loading/saving and improved UX; change note types to emphasize important workflow changes. Clarify the progress estimate as a relative metric, update wording for trails and trajectory plot behavior, and refine the explanation of automatic config.yaml lookup for drag-&-drop loading. Fix a typo ("sratch" -> "scratch") and expand the data-loading recovery note to indicate fewer remapping issues and fewer incorrect loads. Small phrasing tweaks throughout for clarity and consistency.
Update v0_3_0_0 release notes to emphasize that users should not always add the config.yaml when loading labeled data (the plugin will search parent folders). Add a note explaining when dragging/dropping the config.yaml is still required — to start annotating from scratch or to refresh body parts after modifying config.yaml — and that resuming annotation or loading existing annotations does not require it.
C-Achard
added a commit
that referenced
this pull request
May 4, 2026
…199) * Plugin refactor [docs]: Add v0.3.0.0 release notes and images (#195) * Add v0.3.0.0 release notes and images Add release notes for v0.3.0.0 (docs/release_notes/v0_3_0_0.md) describing a near-complete plugin rewrite, safety and debugging improvements, UI and workflow changes, data loading/saving fixes, and other quality-of-life and code-quality updates. Include accompanying images used by the notes (status_panel, color_scheme_skip, traj_plot, tutorial, shortcuts, debug, new_menu, and others) under docs/release_notes/imgs/v_0_3_0_0/. * Update v0.3.0 release notes Add notes about a minimal deprecation system and new debug contexts for performance monitoring and automated log generation. Also add a link to issue #184 for refactor discussion, adjust final wording, and apply minor formatting/whitespace fixes in the drag-&-drop and closing paragraphs. * mdformat * Add stages and split ruff hooks Introduce default_stages and explicitly assign stages to hooks, marking safe checks as pre-commit/manual and file-modifying hooks as pre-commit-only. Add check-merge-conflict, set name-tests-test args, and ensure end-of-file-fixer/trailing-whitespace run only in pre-commit. Bump pyproject-fmt to v2.21.1 and update ruff pre-commit to v0.15.12, replacing the previous ruff entries with a clear split: local autofix/format hooks (pre-commit) and CI check-only variants (manual) with appropriate args. Remove the napari-plugin-checks entry and reorganize hooks for clearer local vs CI behavior. * Add table * Update v0_3_0_0.md * Update v0.3.0.0 release notes Revise docs/release_notes/v0_3_0_0.md to clarify plugin behavior and improve wording. Reword the intro to highlight safety improvements around data loading/saving and improved UX; change note types to emphasize important workflow changes. Clarify the progress estimate as a relative metric, update wording for trails and trajectory plot behavior, and refine the explanation of automatic config.yaml lookup for drag-&-drop loading. Fix a typo ("sratch" -> "scratch") and expand the data-loading recovery note to indicate fewer remapping issues and fewer incorrect loads. Small phrasing tweaks throughout for clarity and consistency. * Dedent admonitions * Clarify config.yaml handling in release notes Update v0_3_0_0 release notes to emphasize that users should not always add the config.yaml when loading labeled data (the plugin will search parent folders). Add a note explaining when dragging/dropping the config.yaml is still required — to start annotating from scratch or to refresh body parts after modifying config.yaml — and that resuming annotation or loading existing annotations does not require it. * Update links * Update v0_3_0_0.md
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
2 participants
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.
Scope
Add release notes for v0.3.0.0 (docs/release_notes/v0_3_0_0.md) describing a near-complete plugin rewrite, safety and debugging improvements, UI and workflow changes, data loading/saving fixes, and other quality-of-life and code-quality updates. Include accompanying images used by the notes (status_panel, color_scheme_skip, traj_plot, tutorial, shortcuts, debug, new_menu, and others) under docs/release_notes/imgs/v_0_3_0_0/.
TODO
https://raw.githubusercontent.com/DeepLabCut/napari-deeplabcut/v0.3.0.0/docs/imgs/v_0_3_0_0/status_panel.png