Skip to content

docs: redesign README - install, quick start, link to docs#28

Merged
George-iam merged 1 commit intomainfrom
feat/readme-redesign-20260328
Mar 28, 2026
Merged

docs: redesign README - install, quick start, link to docs#28
George-iam merged 1 commit intomainfrom
feat/readme-redesign-20260328

Conversation

@George-iam
Copy link
Copy Markdown
Contributor

Summary

  • Remove copy-pasted "What Is AXME?", "AXP — the Intent Protocol", "AXME Cloud" blocks
  • Remove inline diagrams and large reference sections (HITL table, Cross-org, MCP, Enterprise admin, Nick)
  • New structure: install → quick start → human approvals → observe events → examples → dev → related
  • Result: ~80 lines vs 434 lines

Why

SDK READMEs are landing pages, not manuals. Developers want: install command, working example, link to docs.

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