clone

a deno framework for local-first web apps that open instantly, work offline and sync when users choose

docs: replace the Start-here flowchart with a reading-path table

Dami committed f3d7309
The flowchart duplicated the numbered list under it and rendered poorly;
the table carries the same order and descriptions, with the blocked-step
escape hatch as a sentence pointing at Troubleshooting.
commit
f3d73094b1958fc9513484d268d33d45c1631ac0
parent
c981b1a8fa02ab760d2e575d7f6ed846635cfa4a
author
Dami <dami.etoile@gmail.com>
1 file changed, +14 -25
Mdocs/README.md39+++++++++++-------------------
M docs/README.md +14 -25
@@ -6,31 +6,20 @@ sketches under `docs/spikes/`.
66 77 ## Start here88 9-```mermaid10-flowchart LR11- A["Create and run"] --> B["Model data and permissions"]12- B --> C["Build the Preact UI"]13- C --> D["Add sync if needed"]14- D --> E["Test local-first behavior"]15- E --> F["Build and deploy"]16- A -. "blocked" .-> G["Troubleshoot"]17- B -. "blocked" .-> G18- D -. "blocked" .-> G19- E -. "blocked" .-> G20-```21-22-1. [Getting started](getting-started.md) — scaffold an app, verify local persistence, and identify23- the files you are expected to change.24-2. [Data and UI](data-and-ui.md) — connect a Jazz table to a typed Preact hook and island.25-3. [Permissions](permissions.md) — understand and change the starter's owner-only access policy.26-4. [Sync and recovery](sync-and-recovery.md) — provision managed sync and understand the account27- lifecycle.28-5. [Testing](testing.md) — run fast tests and the opt-in two-client offline convergence example.29-6. [Deployment](deployment.md) — build, preview, customize, and host the static PWA.30-7. [Application-origin migration](application-origin-migration.md) — move a deployed app across a31- browser security boundary with explicit recovery, verification, rollback, and retirement.32-8. [Troubleshooting](troubleshooting.md) — diagnose common environment, browser, build, and test33- failures.9+Work through the guides in order; each builds on the project state the previous one leaves behind.10+11+| Step | Guide | What you do |12+| ---- | --------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- |13+| 1 | [Getting started](getting-started.md) | Scaffold an app, verify local persistence, and identify the files you are expected to change. |14+| 2 | [Data and UI](data-and-ui.md) | Connect a Jazz table to a typed Preact hook and island. |15+| 3 | [Permissions](permissions.md) | Understand and change the starter's owner-only access policy. |16+| 4 | [Sync and recovery](sync-and-recovery.md) | Provision managed sync and understand the account lifecycle. |17+| 5 | [Testing](testing.md) | Run fast tests and the opt-in two-client offline convergence example. |18+| 6 | [Deployment](deployment.md) | Build, preview, customize, and host the static PWA. |19+| 7 | [Application-origin migration](application-origin-migration.md) | Move a deployed app across a browser security boundary with recovery, verification, rollback, and retirement. |20+21+Blocked at any step — environment, browser, build, or test failures? Go straight to22+[Troubleshooting](troubleshooting.md).3423 3524 The root [README](https://github.com/FelineStateMachine/lofi/blob/main/README.md) provides the3625 shortest product overview and command summary.