Work

Code Reading Kit

A documentation pattern for explaining implementation decisions through concise examples and annotated prose.

Brief

Technical readers need code that scans cleanly in both light and dark modes, with surrounding prose that explains why the snippet exists.

Approach

MDX pages pair short explanations with syntax-highlighted examples and a controlled measure.

export const describeDecision = (constraint: string) => ({
  constraint,
  outcome: 'Keep the public API small.',
});