Skip to content

docs: simplify root README for first-landing#221

Merged
enricopiovesan merged 2 commits into
mainfrom
cursor/ticket-readme-first-landing-simplify-824d
Jul 21, 2026
Merged

docs: simplify root README for first-landing#221
enricopiovesan merged 2 commits into
mainfrom
cursor/ticket-readme-first-landing-simplify-824d

Conversation

@enricopiovesan

Copy link
Copy Markdown
Contributor

Summary

Rewrite the root README as a first-landing page for humans and LLMs:

  • Apps we have built — traverse-starter, doc-approval, meeting-notes, trace-explorer (+ lighter demos)
  • By OS / target — one entry point per platform, plus a full app×OS matrix
  • Same business logic on multiple OS — three steps + Web quick start
  • Drop architecture, tiers, roadmap, blocked, and project-structure front matter; deeper docs stay in a short footer table

Also retarget two cross-links that pointed at the old “Platform clients” section.

Governing Spec

  • Product feedback: first visit should answer apps / OS start / multi-OS reuse
  • Project 2 readme-first-landing-simplify (PVTI_lADOEbiBt84BbzAzzgznpoE)

Project Item

  • Ticket ID: readme-first-landing-simplify

Definition of Done

  • README lists completed apps with purpose + path
  • README lists per-OS start paths
  • README has multi-OS same-logic start section
  • No architecture / roadmap / What’s Blocked on the front door
  • bash scripts/ci/repository_checks.sh passes locally

Validation

bash scripts/ci/repository_checks.sh
Open in Web Open in Cursor 

cursoragent and others added 2 commits July 21, 2026 20:53
Replace architecture/roadmap/board front matter with three lists:
completed apps, per-OS entry points, and multi-OS same-logic start.
Point a couple of doc cross-links at the new shape.

Co-authored-by: Enrico Piovesan <enricopiovesan@users.noreply.github.com>
Co-authored-by: Enrico Piovesan <enricopiovesan@users.noreply.github.com>
@enricopiovesan
enricopiovesan marked this pull request as ready for review July 21, 2026 20:53
@enricopiovesan
enricopiovesan enabled auto-merge (squash) July 21, 2026 20:53
@enricopiovesan
enricopiovesan merged commit 206a82b into main Jul 21, 2026
8 checks passed
@enricopiovesan
enricopiovesan deleted the cursor/ticket-readme-first-landing-simplify-824d branch July 21, 2026 20:54
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.

2 participants