Skip to content
Open
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Add quick-start index and anchor labels
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.
  • Loading branch information
C-Achard committed May 12, 2026
commit 8c20221af2cb7a64e36b161abb44c415810dc636
4 changes: 4 additions & 0 deletions docs/quick-start/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Quick start guides

- Single animal: {ref}`file:single-animal-quick-start`
- Multi-animal: {ref}`file:multi-animal-quick-start`
2 changes: 2 additions & 0 deletions docs/quick-start/single_animal_quick_guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ deeplabcut:
notes: This is a bit stuck between minimal guide and quick start, as the lack of explanations makes it more into a catalogue of commands (which is an API docs responsibility), and a proper quick start guide that gives users a proper sense of the workflow. This should either be expanded greatly or simply archived. For simplicity, I recommend archiving.
---

(file:single-animal-quick-start)=

# QUICK GUIDE to single Animal Training:

**The main steps to take you from project creation to analyzed videos:**
Expand Down
2 changes: 2 additions & 0 deletions docs/quick-start/tutorial_maDLC.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ deeplabcut:
recommendation: keep
---

(file:multi-animal-quick-start)=

# Multi-animal pose estimation with DeepLabCut: A 5-minute tutorial

## GUI:
Expand Down