You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: AGENTS.md
+1Lines changed: 1 addition & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -79,6 +79,7 @@ When someone wants to use this in an app they’re working on, point them to the
79
79
-**docs/PRINCIPLES_AND_GOALS.md** – Core principles (local-first, data sovereignty, sync later, interoperability); why TinyBase and Solid; what we commit to. **Start here for the "why."**
80
80
-**docs/INTEGRATION_GUIDE.md** – Step-by-step integration (install vs copy-paste), store setup, Provider, components, CLI.
81
81
-**docs/USE_CASES.md** – How app authors access and manage users, groups, and documents.
82
+
-**docs/VERSIONING.md** – Versioning strategy, build metadata, release process, and step-by-step instructions for cutting releases.
82
83
-**docs/SHORTCOMINGS.md** – What the library does *not* provide (no WAC, no "shared with me," no p2p transport, etc.).
83
84
-**docs/DOCUMENT_SHARING_SCENARIOS.md** – Sharing scenarios (Solid or ad hoc p2p).
Copy file name to clipboardExpand all lines: README.md
+19Lines changed: 19 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -257,6 +257,25 @@ Feature files live under `tests/features/` (e.g. `cli-contacts.feature`, `app.fe
257
257
258
258
For more detail (where results are stored, unit/BDD/Storybook guidelines), see **[docs/testing/](docs/testing/README.md)**. For coding standards (strict TypeScript, short functions, simple components), see **[docs/CODING_GUIDELINES.md](docs/CODING_GUIDELINES.md)**.
259
259
260
+
## Documentation
261
+
262
+
Comprehensive documentation is available in the `docs/` directory:
263
+
264
+
-**[docs/PRINCIPLES_AND_GOALS.md](docs/PRINCIPLES_AND_GOALS.md)** – Core principles, why TinyBase and Solid, what we commit to
0 commit comments