Skip to content

docs: add beginner primer for core concepts#26

Merged
marcus merged 1 commit intomarcus:mainfrom
FredLackey:main
Feb 16, 2026
Merged

docs: add beginner primer for core concepts#26
marcus merged 1 commit intomarcus:mainfrom
FredLackey:main

Conversation

@FredLackeyOfficial
Copy link
Contributor

Summary

  • Adds docs/primer.md, a beginner-friendly guide covering td's core concepts
    and how they relate to each other
  • Aimed at newcomers who find the existing documentation overwhelming and need a
    single starting point before diving into the detailed docs

The primer covers:

  • Where td stores data and what a "project" actually is
  • The data model hierarchy (issues, epics, boards, sessions, handoffs, logs, dependencies)
  • Issue lifecycle and session isolation
  • Syncing across machines
  • Multi-repo vs monorepo project organization and tradeoffs

Motivation

The current documentation is written for someone who already understands td. It's
great as a reference but assumes familiarity with the concepts. This primer is a
quick 30-second read that helps someone new understand what td is, how the pieces
fit together, and how they'd use it before they start digging into the detailed docs.

@marcus marcus merged commit 54ed1bb into marcus:main Feb 16, 2026
@marcus
Copy link
Owner

marcus commented Feb 16, 2026

Thanks for putting this together, Fred! 🎉 The primer is a great addition — having a single "start here" doc that walks through the data model, session isolation, and project organization will really help newcomers get oriented before diving into the reference docs. Merged!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants