Skip to content

docs: improve TypeScript integration documentation#4

Merged
rlippmann merged 2 commits into
mainfrom
codex/ts-examples2
Jun 18, 2026
Merged

docs: improve TypeScript integration documentation#4
rlippmann merged 2 commits into
mainfrom
codex/ts-examples2

Conversation

@rlippmann

Copy link
Copy Markdown
Owner

What changed

Documentation

  • Simplify wording across TypeScript integration documentation
  • Make compiler-only workflows more prominent
  • Clarify that directive-drafter is optional
  • Improve explanations of checkpoint persistence and pending clarify/confirm state
  • Clarify downstream host/model handoff points
  • Improve starter-app guidance and smoke-test documentation

Repository guidance

  • Strengthen AGENTS.md guidance around:
    • documentation as project contract
    • optional components
    • example migration and replacement
    • behavior-first documentation

Why

Recent TypeScript example and extraction work exposed a few recurring documentation issues:

  • optional components being presented as required
  • behavior being explained through architecture first
  • educational material being removed before replacement coverage was verified

These changes make the examples easier to understand and make repository expectations clearer for future contributions.

@rlippmann rlippmann merged commit 7e51792 into main Jun 18, 2026
1 check passed
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.

1 participant