Skip to content

Redesign README: protocol-first structure#36

Merged
George-iam merged 2 commits intomainfrom
feat/readme-redesign-20260328
Mar 28, 2026
Merged

Redesign README: protocol-first structure#36
George-iam merged 2 commits intomainfrom
feat/readme-redesign-20260328

Conversation

@George-iam
Copy link
Copy Markdown
Contributor

Summary

  • Remove "What Is AXME?" and "AXME Cloud" sections - readers arrive already knowing what AXME is; this repo is about the protocol spec
  • Add protocol-first header with tagline, badges (Alpha, License), and nav links to axme, Docs, Conformance
  • Reorder sections: What Lives Here up front, then Intent Lifecycle, Delivery Bindings, Human Task Types, ScenarioBundle, Protocol Envelope, Related Repositories
  • Add structured footer: hello@axme.ai, @axme_ai, Security, License
  • All existing content (state machine, tables, ScenarioBundle example, Protocol Envelope diagram, Schema Governance details) preserved and unchanged

Test plan

  • Verify badges render correctly on GitHub
  • Verify all links resolve (nav links, footer links, diagram images)
  • Verify <details> Schema Governance block expands correctly

@George-iam George-iam merged commit 38554c5 into main Mar 28, 2026
1 check passed
@George-iam George-iam deleted the feat/readme-redesign-20260328 branch March 28, 2026 09:33
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