Skip to content

docs: rewrite README around current install and integration surface#96

Merged
davidahmann merged 1 commit intomainfrom
codex/readme-rewrite-current-surface
Mar 17, 2026
Merged

docs: rewrite README around current install and integration surface#96
davidahmann merged 1 commit intomainfrom
codex/readme-rewrite-current-surface

Conversation

@davidahmann
Copy link
Copy Markdown
Collaborator

Problem

The top-level README was mixing an older proposal narrative with the current shipped Gait surface. That made the install story, integration contract, and framework claims harder to follow than they should be.

Changes

  • rewrote the README hero around execution-boundary enforcement, signed proof, and deterministic regressions
  • split the funnel into three truthful entry paths: first proof, repo policy onboarding, and runtime integration
  • aligned install paths to current Homebrew, go install, and release-installer options
  • tightened framework messaging to the current shipped lanes: OpenAI Agents wrapper lane and LangChain middleware with optional callback correlation
  • kept MCP trust, observability positioning, regress/CI, and compliance sections aligned with the current CLI and docs contracts

Validation

  • gait doctor --json
  • make test-docs-consistency
  • make test-docs-storyline
  • make prepush-full

@davidahmann davidahmann merged commit af40c0e into main Mar 17, 2026
7 checks passed
@davidahmann davidahmann deleted the codex/readme-rewrite-current-surface branch March 17, 2026 20:45
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