Skip to content

docs: rewrite README with feature-parity matrix#44

Merged
JohnMcLear merged 1 commit into
mainfrom
docs/feature-parity-readme
May 12, 2026
Merged

docs: rewrite README with feature-parity matrix#44
JohnMcLear merged 1 commit into
mainfrom
docs/feature-parity-readme

Conversation

@JohnMcLear

Copy link
Copy Markdown
Member

Summary

The README still claimed mobile was a Capacitor scaffold with stub Platform. Replaces it with a current-state feature matrix.

  • Spells out the unified-UX goal (shared shell, runtime-injected Platform) and the one expected divergence: offline editing.
  • ~40-row matrix across workspaces, pads/tabs, deep links, i18n, keyboard/gestures, permissions, packaging, tests.
  • What's Next grouped Soon / Later / Non-goals — offline-editing divergence flagged explicitly (desktop cache + OT replay vs mobile CRDT queue).

Test plan

  • Renders correctly on GitHub-flavoured markdown (preview)
  • Reviewer sanity-checks the parity matrix vs. their mental model

The previous README still described mobile as a "Capacitor scaffold (stub Platform; persistence and native plugins pending)" — wildly stale after Phases 4-7 shipped. Re-anchor it on what actually works today and where the two shells diverge.

- Spell out the unified-UX goal: shell is shared, runtimes inject a Platform. State the one expected divergence point: offline editing (desktop cache-then-OT-replay vs mobile CRDT local-edit-queue).
- Add a 7-section feature matrix (~40 rows) covering workspaces, pads/tabs, deep links, settings/i18n, keyboard/gestures, permissions, packaging, tests. Empty / ⏳ / ✅ keys per shell.
- Update package status (mobile is no longer "Capacitor scaffold").
- Add a What's-Next section grouped Soon / Later / Non-goals, with the offline-editing divergence flagged explicitly.
- Keep quick-start commands inline and point per-package READMEs at developer docs.
@qodo-code-review

Copy link
Copy Markdown
ⓘ You've reached your Qodo monthly free-tier limit. Reviews pause until next month — upgrade your plan to continue now, or link your paid account if you already have one.

@JohnMcLear
JohnMcLear merged commit ee9c3e2 into main May 12, 2026
2 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