Skip to content

Redesign README: direct structure, example tables first#37

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

Redesign README: direct structure, example tables first#37
George-iam merged 2 commits intomainfrom
feat/readme-redesign-20260328

Conversation

@George-iam
Copy link
Copy Markdown
Contributor

Summary

  • Remove "What Is AXME?" intro - readers arrive already knowing the product
  • Move example tables (delivery, human, internal, durability, full workflows, model-a) to the top, immediately after the header
  • Add badges (Alpha status, License) and nav links to header
  • Collapse repo structure, SDK versions, env vars, and related repos into a <details> block
  • Add footer with contact, social, security, and license links
  • All existing content preserved - reorganized only

Test plan

  • Verify all section links resolve correctly in rendered markdown
  • Confirm badges render (Alpha, License)
  • Confirm <details> block expands correctly on GitHub
  • Spot-check all tables are complete and unmodified

@George-iam George-iam merged commit 0db761f 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