Update napari-DLC docs for refactor - #3280
Merged
Merged
Conversation
Create two new napari-DLC documentation pages (docs/gui/napari/basic_usage.md and docs/gui/napari/advanced_usage.md) containing usage instructions, workflows, shortcuts, and feature descriptions for the plugin. Update _toc.yml to expose the basic_usage page under the napari_GUI section so the new docs appear in the site navigation. Frontmatter on the new files sets last_updated metadata.
napari-DLC docs basic usage
Include the napari advanced usage page in the documentation table of contents and add named anchors to both basic and advanced napari docs for stable cross-referencing. This ensures the pages appear in the nav and can be linked reliably from other docs.
Replace legacy internal references to the napari docs with a new landing-page target and simplify the napari GUI doc. Updated links in labeling.md, PROJECT_GUI.md, maDLC_UserGuide.md, and standardDeepLabCut_UserGuide.md to point to file:napari-gui-landing. Reworked docs/gui/napari_GUI.md into a concise landing page (file:napari-gui-landing) with a table of contents and links to installation, basic usage, and advanced features to better organize napari-related guidance.
C-Achard
added
documentation
deruyter92
reviewed
Apr 10, 2026
deruyter92
left a comment
deruyter92
left a comment
Collaborator
There was a problem hiding this comment.
Great work, I like that you're adding a separate advanced usage document. The sections about saving behavior will also serve a good reference when working on the keypoint refactoring.
26 tasks
C-Achard
marked this pull request as ready for review
April 28, 2026 07:34
C-Achard
marked this pull request as draft
April 28, 2026 07:34
C-Achard
marked this pull request as ready for review
April 30, 2026 07:55
Merged
3 tasks
Update napari plugin documentation to clarify behavior and workflows. Changes include: automatic opening behavior, guidance for standalone installation, notes about auto-reading project config from CollectedData_<ScorerName>.h5, explicit instructions for editing and hiding layers when refining machinelabels, confirmation/save behavior clarifications (h5 is authoritative; CSVs and machine labels are not used for training), tips for video workflows, handling when multiple folders are opened, and an updated demo note with link. Also minor formatting and numbering fixes in basic and advanced usage pages.
MMathisLab
approved these changes
May 4, 2026
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
3 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.
As DeepLabCut/napari-deeplabcut#175 is approaching completion, this PR updates and expands the napari-DLC relevant docs to be more complete and up-to-date.
Also fixes minor typos in other docs where found.
TODO
Requires :
Automated summary
This pull request expands and improves the documentation for the napari-based DeepLabCut GUI, focusing on clearer navigation, more comprehensive guides, and fixing reference errors.
Two new pages—basic usage and advanced features—have been added for the napari GUI, with links and references updated throughout the docs to point to these new resources.
Additionally, several typos in internal references have been corrected, ensuring that cross-page links work as intended.
Documentation Improvements for napari GUI:
docs/gui/napari/basic_usage.md(basic usage) anddocs/gui/napari/advanced_usage.md(advanced features), providing detailed guides and workflows for the napari-based labeling GUI. [1] [2]_toc.yml) to include the new napari GUI sections, making them accessible from the main navigation.PROJECT_GUI.md,labeling.md) to point to the new napari GUI landing page and sections, replacing older or broken links. [1] [2]Reference and Typo Fixes:
dlclivegui-tinmestamp-format→dlclivegui-timestamp-format) in multiple files, ensuring correct cross-references. [1] [2] [3]