Docs audit [April 2026]: TOC update & streamlining#3308
Open
C-Achard wants to merge 8 commits into
Open
Conversation
Reorganize the book TOC (_toc.yml) into clearer sections (Getting started, Main workflows, GUI workflow, Notebooks & Demos, Advanced/Performance & Live, Additional guides, Project & Community). Add new index pages for GUI, notebooks (main_demos, your_data, extra), PyTorch, and recipes. Adjust headings in maDLC and standardDeepLabCut user guides to shorter titles. This clarifies navigation and groups related docs and examples under logical headings.
Update _toc.yml to add napari/basic_usage and napari/advanced_usage entries, adjust chapter/section ordering (relocating the beginner-guides block) and remove the redundant docs/gui/index entry.
Reorganize _toc.yml to add and move documentation entries: reintroduce napari_GUI section, add dlc-live GUI pages (quickstart, user guide, camera backends with individual backend pages, and misc/modelzoo pages), and relocate the ModelZoo entry into the 'Advanced, Performance & Live' section while removing duplicates. Also update docs/recipes/index.md heading from 'Additional guides' to 'The DeepLabCut Cookbook'.
Reorganize table of contents: relocate docs/dlc-live/deeplabcutlive from the Benchmark section into the ModelZoo sections (removing the duplicate entry) and comment out the docs/course entry to temporarily hide the course page. Only _toc.yml was modified.
Create docs/quick-start/index.md listing single- and multi-animal quick start guides, and add explicit file anchors to the single_animal_quick_guide.md and tutorial_maDLC.md files ((file:single-animal-quick-start) and (file:multi-animal-quick-start)). These changes centralize quick-start entry points and enable stable cross-references; also include minor whitespace/formatting cleanup.
Collaborator
Author
|
@deruyter92 Should we keep the quick start guides listed for now ? What do you think ? |
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
1 participant
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.
Motivation
This PR is part of a broader documentation auditing process, which aims to offer a clean, systematic review of current documentation, suggest potential improvements, and start updating critical pages.
See:
Suggested merge order:
Scope
Updates the table of contents, with the following aims: