Skip to content

Redesign README: docs-first, remove AXME intro, key documents prominent#65

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

Redesign README: docs-first, remove AXME intro, key documents prominent#65
George-iam merged 3 commits intomainfrom
feat/readme-redesign-20260328

Conversation

@George-iam
Copy link
Copy Markdown
Contributor

Summary

  • Removes the "What Is AXME?", "AXP - the Intent Protocol", and "AXME Cloud" intro blocks (explanatory content that belongs in axme-spec, not the docs repo)
  • Promotes Integration Quickstart to the top as the primary CTA
  • Adds badges (Alpha status, License) and nav links in the header
  • Moves repo structure tree and visualization program info into collapsed <details> blocks
  • Adds a footer line with contact, social, security, and license links
  • All diagrams, tables, and existing content preserved - reorganized only

Test plan

  • Review rendered README on GitHub to confirm diagrams display correctly
  • Confirm all internal document links resolve
  • Confirm badge links and nav links are correct

README now has 1 diagram (System Context C4). Intent lifecycle moved to
D1 intents doc, container runtime to enterprise-runtime doc, trust boundary
and auth flow to security-overview, protocol envelope and idempotency to
integration-quickstart.
@George-iam George-iam merged commit 010300f into main Mar 28, 2026
1 check passed
@George-iam George-iam deleted the feat/readme-redesign-20260328 branch March 28, 2026 09:38
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