Skip to content

Commit aadeb12

Browse files
committed
add build/version footer + versioning doc; run unit tests during build
1 parent adbd136 commit aadeb12

9 files changed

Lines changed: 1230 additions & 11 deletions

File tree

.github/workflows/pages.yml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,9 @@ jobs:
2525
- name: Install dependencies
2626
run: npm ci
2727

28+
- name: Run unit tests
29+
run: npm run test:run
30+
2831
- name: Generate JSON Schemas
2932
run: npm run generate:schemas
3033

AGENTS.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -79,6 +79,7 @@ When someone wants to use this in an app they’re working on, point them to the
7979
- **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."**
8080
- **docs/INTEGRATION_GUIDE.md** – Step-by-step integration (install vs copy-paste), store setup, Provider, components, CLI.
8181
- **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.
8283
- **docs/SHORTCOMINGS.md** – What the library does *not* provide (no WAC, no "shared with me," no p2p transport, etc.).
8384
- **docs/DOCUMENT_SHARING_SCENARIOS.md** – Sharing scenarios (Solid or ad hoc p2p).
8485
- **docs/SOLID_SERVER_STRATEGIES.md** – Sync design, authority modes, implementation order.

README.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -257,6 +257,25 @@ Feature files live under `tests/features/` (e.g. `cli-contacts.feature`, `app.fe
257257

258258
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)**.
259259

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
265+
- **[docs/INTEGRATION_GUIDE.md](docs/INTEGRATION_GUIDE.md)** – Step-by-step integration guide
266+
- **[docs/USE_CASES.md](docs/USE_CASES.md)** – How to access and manage users, groups, and documents
267+
- **[docs/VERSIONING.md](docs/VERSIONING.md)** – Versioning strategy, build metadata, and release process
268+
- **[docs/SHORTCOMINGS.md](docs/SHORTCOMINGS.md)** – What the library does not provide
269+
- **[docs/DOCUMENT_SHARING_SCENARIOS.md](docs/DOCUMENT_SHARING_SCENARIOS.md)** – Sharing scenarios
270+
- **[docs/SOLID_SERVER_STRATEGIES.md](docs/SOLID_SERVER_STRATEGIES.md)** – Sync design and strategies
271+
- **[docs/CODING_GUIDELINES.md](docs/CODING_GUIDELINES.md)** – TypeScript and React coding standards
272+
- **[docs/DOCUMENTATION_GUIDELINES.md](docs/DOCUMENTATION_GUIDELINES.md)** – How to write documentation
273+
- **[docs/IMPLEMENTATION_PLAN.md](docs/IMPLEMENTATION_PLAN.md)** – Feature phases and roadmap
274+
- **[docs/TEST_PLAN.md](docs/TEST_PLAN.md)** – Test phases and verification
275+
- **[docs/testing/](docs/testing/README.md)** – Unit, BDD/E2E, and Storybook guides
276+
- **[docs/SDLC_PROCESS.md](docs/SDLC_PROCESS.md)** – Development lifecycle and process
277+
- **[DESIGN.md](DESIGN.md)** – Design notes
278+
260279
## License
261280

262281
AGPL-3.0-or-later. See [LICENSE](LICENSE).

0 commit comments

Comments
 (0)