Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Tutorials

Begin with a structural diff. The remaining tutorials extend the same User example from a schema to a migration, a version history, and a conversion between protocols.

Follow the beginner path in order:

  1. Your first diff compares two ATProto Lexicon documents from the command line. This is the quick success path.
  2. Your first schema builds and validates the same model with the TypeScript SDK.
  3. Your first migration renames a field, converts a record, and checks the reverse trip.

The next two tutorials branch from that foundation. Schema version control basics is the intermediate path for commits, branches, and structural merge. Cross-protocol translation is the advanced path for an explicit conversion between schemas registered under different protocols.

TutorialResult
Your first diffOne structural diff over two schema documents
Your first schemaA schema plus valid and invalid records
Your first migrationA checked rename with a round-trip assertion
Schema version control basicsA repository with a branch and fast-forward merge
Cross-protocol translationA narrow forward conversion between structurally compatible schemas

Tutorials are learning-oriented: each leaves you with a runnable result and explains only the concepts needed to produce it. The how-to guides collect task-specific procedures, the reference records the complete interfaces, and the explanation chapters develop the theory behind the commands.