Tutorials Workspace Guide

April 13, 2026 ยท View on GitHub

Use this guide to navigate all tutorial tracks, understand structure rules, and jump to the right discovery surface quickly.

Primary Entry Points

Snapshot (auto-generated)

MetricValue
Tutorial directories203
Tutorial markdown files1830
Tutorial markdown lines706,077

Source Verification Snapshot

Repository-source verification run against tutorial index references (GitHub API, 2026-02-24):

SignalValue
Tutorials scanned203
Tutorials with source repos203
Tutorials with unverified source repos0
Unique verified source repos214

Content Structure Patterns

PatternCountDescription
Root chapter files203README.md + top-level 01-...md to 08-...md
docs/ chapter files0Deprecated and fully migrated
Index-only roadmap0All catalog entries publish full chapter sets
Mixed root + docs/0Legacy hybrid layout removed

Tutorial UX Contract

Each tutorial index should provide:

  • a clear chapter guide with direct links
  • source references to upstream docs/repos
  • related tutorial links for cross-track navigation
  • a Navigation & Backlinks section to connect back to core discovery surfaces

Structure Contract

Each tutorial directory should contain:

  • README.md
  • 01-...md through 08-...md at the tutorial root (not under docs/)

Maintainer Commands

# Refresh tutorial metrics and structure snapshot
python3 scripts/update_tutorials_readme_snapshot.py --root .

# Re-verify tutorial source repositories
python3 scripts/verify_tutorial_sources.py --root .

# Run docs health checks
python3 scripts/docs_health.py --root .

Quick Actions