Skip to content

docs: slim down README, point to Wiki for details#24

Merged
Cloriskitty merged 2 commits intomainfrom
docs/slim-readme
Mar 30, 2026
Merged

docs: slim down README, point to Wiki for details#24
Cloriskitty merged 2 commits intomainfrom
docs/slim-readme

Conversation

@Cloriskitty
Copy link
Copy Markdown
Contributor

Summary

  • Slim down README from ~170 lines to ~70 lines — keep only essentials (intro, install, quick start)
  • Move detailed content (Trust Layer, Compliance Architecture, Environment Variables, Entity Secret, Production Canary) to the Wiki
  • Add a Documentation table linking to all 6 Wiki pages: Getting Started, Architecture, Compliance Design, Trust & ERC-8004, API Reference, Contributing Guide

Why

The README was getting long and duplicated content that now lives in the Wiki. A concise README with clear Wiki links is easier for new users to scan and reduces maintenance burden.

Test plan

  • Verify all Wiki links in the Documentation table resolve correctly
  • Confirm install and quick start instructions still accurate
  • Check rendering on GitHub

@Cloriskitty Cloriskitty added the documentation Improvements or additions to documentation label Mar 30, 2026
@Cloriskitty Cloriskitty merged commit 6390b4a into main Mar 30, 2026
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant