Skip to content

docs: refresh README with real graph gallery - #280

Merged
forhappy merged 4 commits into
mainfrom
codex/readme-marketing-refresh
Aug 23, 2026
Merged

docs: refresh README with real graph gallery#280
forhappy merged 4 commits into
mainfrom
codex/readme-marketing-refresh

Conversation

@forhappy

@forhappy forhappy commented Aug 23, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Rework the README into a polished, technical product introduction.
  • Keep a real screenshot gallery with four Compass exports from public repositories.
  • Restore detailed onboarding, install and upgrade behavior, VS Code navigation, assistant orientation, query pagination, MCP integration, Program IR evidence, history reports, CompassQL, capability boundaries, and documentation routing.
  • Preserve the local-first, bounded, evidence-oriented technical positioning.

Screenshot sources

Validation

  • git diff --check
  • Verified 47 local README link and asset targets
  • Verified four 1600x1000 PNG gallery assets
  • README now contains 2,861 words versus 2,417 in the original
  • No Rust or JavaScript tests run because this change only affects documentation and images.

@forhappy
forhappy merged commit acc4918 into main Aug 23, 2026
14 checks passed
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