Skip to content

test: add CI verification for README examples #17

Description

@aridyckovsky

Add automated testing to ensure README examples stay accurate and in sync with CLI behavior.

Approach:

  1. Create pnpm run doc-test script
  2. Extract and run key examples (thread add/list, audit)
  3. Verify output matches documented examples
  4. Run in CI on every PR

Benefits:

  • Prevents documentation drift
  • Catches breaking changes early
  • Increases confidence in examples

File: README.md

Review: docs/agents/prs/reviews/amp/feat-thread-command.md

Activity

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    good-first-issueGood for newcomerspkg:cliIssues related to @effect-migrate/cli packagepriority:lowLow prioritytype:docsDocumentation improvementstype:testTesting improvements

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions