Skip to content

Latest commit

 

History

History
78 lines (55 loc) · 2.79 KB

File metadata and controls

78 lines (55 loc) · 2.79 KB

Tutorials Workspace Guide

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)

Metric Value
Tutorial directories 201
Tutorial markdown files 1812
Tutorial markdown lines 730,014

Source Verification Snapshot

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

Signal Value
Tutorials scanned 201
Tutorials with source repos 201
Tutorials with unverified source repos 0
Unique verified source repos 214

Content Structure Patterns

Pattern Count Description
Root chapter files 201 README.md + top-level 01-...md to 08-...md
docs/ chapter files 0 Deprecated and fully migrated
Index-only roadmap 0 All catalog entries publish full chapter sets
Mixed root + docs/ 0 Legacy 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