◐ Shell
clean mode source ↗

Update napari-DLC docs for refactor by C-Achard · Pull Request #3280 · DeepLabCut/DeepLabCut

added 9 commits

April 9, 2026 14:41
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

deruyter92

@C-Achard

@C-Achard C-Achard marked this pull request as ready for review

April 28, 2026 07:34

@C-Achard C-Achard marked this pull request as ready for review

April 30, 2026 07:55
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