Skip to content

Commit b0a1a03

Browse files
authored
Merge pull request #5 from SQLoot/dev/feat-roadmap-support-sync
docs: Revise public profile README to list repositories and delivery …
2 parents 4232477 + 751ec5d commit b0a1a03

2 files changed

Lines changed: 75 additions & 58 deletions

File tree

README.md

Lines changed: 43 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,46 @@
1-
# .github
2-
Special GitHub repo for organization health files ✨
1+
# SQLoot `.github`
2+
3+
Public organization-health repository for SQLoot.
4+
5+
## Purpose
6+
7+
This repository defines public defaults used across SQLoot repositories:
8+
9+
- community policy files (`CODE_OF_CONDUCT.md`, `CONTRIBUTING.md`, `SECURITY.md`, `SUPPORT.md`)
10+
- issue and pull request templates
11+
- workflow templates for new repositories
12+
- organization profile content (`profile/README.md`)
13+
- shared ownership baseline (`CODEOWNERS`)
14+
15+
## Repository structure
16+
17+
```text
18+
.
19+
├── .github/
20+
│ └── dependabot.yml
21+
├── ISSUE_TEMPLATE/
22+
├── workflow-templates/
23+
├── profile/
24+
│ └── README.md
25+
├── CODEOWNERS
26+
├── CODE_OF_CONDUCT.md
27+
├── CONTRIBUTING.md
28+
├── FUNDING.yml
29+
├── PULL_REQUEST_TEMPLATE.md
30+
├── SECURITY.md
31+
└── SUPPORT.md
32+
```
33+
34+
## Operating rules
35+
36+
- Keep everything public-safe (no internal links, no private roadmap details, no operational secrets).
37+
- Treat changes as org-wide defaults; update with explicit, reviewable edits.
38+
- Keep templates aligned with active delivery priorities in public repos.
39+
40+
## Related repositories
41+
42+
- Public profile: [`profile/README.md`](./profile/README.md)
43+
- Internal-only counterpart: `SQLoot/.github-private`
344

445
---
546

profile/README.md

Lines changed: 32 additions & 56 deletions
Original file line numberDiff line numberDiff line change
@@ -3,83 +3,59 @@
33
</div>
44

55
<p align="center">
6-
<strong>Local-First | Lab | E2EE | Infra | Benchmarks | Tools | CLI | Adapters | CRDT Sync | Relays</strong><br />
7-
Public rollout is in progress (updated March 1, 2026).
6+
<strong>Local-First Runtime, Tooling, Relay Infrastructure, and Evidence-Driven Benchmarks.</strong><br />
7+
Public rollout is in progress.
88
</p>
99

1010
<p align="center">
1111
<img src="https://img.shields.io/badge/Public_rollout-WIP-f59e0b?style=flat-square" alt="Public rollout WIP" />
1212
<img src="https://img.shields.io/badge/Built_on-Evolu-1f6feb?style=flat-square" alt="Foundation Evolu" />
13-
<img src="https://img.shields.io/badge/Compatibility-SQLite-0ea5e9?style=flat-square" alt="SQLite compatibility" />
14-
<img src="https://img.shields.io/badge/Bun-v1.3.10-111827?style=flat-square&logo=bun&logoColor=white" alt="Bun-first runtime" />
13+
<img src="https://img.shields.io/badge/Bun-first%20%7C%20v1.3.10-111827?style=flat-square&logo=bun&logoColor=white" alt="Bun-first | v1.3.10" />
1514
</p>
1615

17-
## Why SQLoot
16+
## Why SQLoot
1817

19-
- 🌍 Grow the local-first community and make the ecosystem easier to discover and adopt.
20-
- 🛠️ Build practical tools and a robust CLI for developers and operators.
21-
- ⚡ Push performance in critical paths with Zig/Rust and systems-level optimizations.
22-
- 🧩 Keep Evolu compatibility while delivering upgrades and upstream-ready improvements.
23-
- 🧪 Run experiments, publish benchmarks, and propose new local-first specs where needed.
24-
- 🤖 Advance local-first collaboration patterns for AI agents.
18+
SQLoot builds local-first infrastructure and products that preserve user data ownership while staying practical for real deployments.
2519

26-
## 🤝 Foundation: Evolu
20+
Current strategy:
2721

28-
SQLoot currently runs on top of an Evolu-based baseline. Our immediate strategy is to preserve upstream compatibility, ship measurable improvements in our fork, and upstream changes where applicable.
22+
- keep compatibility with Evolu upstream where it matters
23+
- ship measurable improvements in SQLoot-owned tracks
24+
- expose benchmark evidence and operational runbooks publicly
2925

30-
- Upstream project: [evoluhq/evolu](https://github.com/evoluhq/evolu)
31-
- Upstream docs: [evolu.dev](https://www.evolu.dev)
32-
- SQLoot baseline fork: [SQLoot/evolu-plan-b](https://github.com/SQLoot/evolu-plan-b)
33-
34-
Credit where it belongs: huge respect to [evoluhq](https://github.com/evoluhq) and [@steida](https://github.com/steida) for creating Evolu and moving the local-first ecosystem forward.
35-
36-
## 🧱 What SQLoot Is Building
26+
## Repository Links
3727

38-
| Track | Role | Current State |
39-
|---|---|---|
40-
| `evolu-plan-b` | Evolu-compatible Bun + Biome baseline | Public rollout |
41-
| `core` | SQLoot-native runtime foundations (Rust/Zig) | Planning |
42-
| `bench-suite` | Reproducible benchmark harness | WIP |
43-
| `relays` | Evolu-compatible relay implementations (Bun+Elysia/Rust/BEAM) | WIP |
44-
| `lootbox` | CLI umbrella, TUI, tools (Rust) | WIP |
45-
| `blind-cloud` | Encrypted cloud transport experiments (vault/relay/repacker) | Research |
46-
| `local-first` | Community forum, blog, wiki, guides | TBD |
47-
| `loot-cms` | File-based CMS, editor, sync storage | Research |
48-
| `loot-ops` | Org-wide platform glue for repos (Nix/IaC/CI) | Private |
49-
| `website` | Landing page, docs, bench measurements, stats | WIP |
50-
| `knowledge` | Obsidian KB, planning, issues, research | Internal |
28+
| Repository | Link status | Purpose | Current focus |
29+
| --- | --- | --- | --- |
30+
| [`evolu-plan-b`](https://github.com/SQLoot/evolu-plan-b) | Available | Evolu-compatible Bun + Biome baseline | Integrations hardening, `Electrobun` bootstrap (P0) |
31+
| `bench-suite` | Link removed (not publicly available) | Reproducible benchmark harness | Regression gates, comparable matrix outputs |
32+
| `relays` | Link removed (not publicly available) | Evolu-compatible relay implementations | Compatibility + hardening lanes |
33+
| `website` | Link removed (not publicly available) | Public docs and product web surfaces | Docs + benchmark visibility |
34+
| `SQLoot.github.io` | Link removed (not publicly available) | Deployment target for public pages | Stable publishing surface |
35+
| `awesome-local-first` | Link removed (not publicly available) | Curated local-first ecosystem list | Curation baseline and taxonomy |
5136

52-
Public docs and public APIs are opening in phases as each track stabilizes.
37+
## 2026 Delivery Priorities
5338

54-
## 🗺️ 2026 Roadmap (WIP)
39+
1. `Electrobun` integration in `evolu-plan-b` as top execution priority.
40+
2. Integration reliability lanes (TanStack Start, Astro, Tauri).
41+
3. Benchmark evidence quality (`p50/p95/throughput/memory`) with reproducible CI output.
42+
4. Relay compatibility hardening with explicit failure-mode testing.
43+
5. Public docs quality and operational guidance for adopters.
5544

56-
### Milestone Progress (as of March 1, 2026)
45+
## Foundation: Evolu
5746

58-
- [x] 📦 Public track for `evolu-plan-b` prepared (100%)
59-
- [x] 🧩 Evolu-based Bun-first baseline established (95%)
60-
- [ ] 🔌 Priority integrations (TanStack Start, Tauri, Astro) (75%)
61-
- [ ] 🧪 Benchmark harness foundation in `bench-suite` (45%)
62-
- [ ] 📊 Regression evidence gates (p50/p95/throughput/memory) (40%)
63-
- [ ] 🌐 Relay and transport hardening (`relays`, `blind-cloud`) (30%)
64-
- [ ] 🧱 SQLoot core bootstrap (`core`) (20%)
65-
- [ ] 🛠️ `lootbox` CLI baseline (scope, commands, packaging) (25%)
66-
- [ ] 📚 Public docs and evidence surfaces (`website`, `local-first`) (35%)
67-
68-
## 🎯 Next 4 Weeks
47+
- Upstream project: [evoluhq/evolu](https://github.com/evoluhq/evolu)
48+
- Upstream docs: [evolu.dev](https://www.evolu.dev)
6949

70-
1. Lock `evolu-plan-b` public baseline: keep CI green, tighten docs, and close rollout gaps.
71-
2. Ship `bench-suite` baseline lanes with reproducible report schema and first regression thresholds.
72-
3. Stabilize integration lanes for TanStack Start, Tauri, and Astro with actionable smoke outputs.
73-
4. Define and run relay hardening matrix for reconnect/load/failure handling in `relays`.
74-
5. Ship `lootbox` CLI v0 scope and first operator commands for workspace/bootstrap + benchmark flows.
50+
Credit to [evoluhq](https://github.com/evoluhq) and [@steida](https://github.com/steida) for creating Evolu and pushing the local-first ecosystem forward.
7551

76-
## 🤝 Contributing
52+
## Contributing
7753

78-
Contributions are welcome. See [CONTRIBUTING](https://github.com/SQLoot/.github/blob/main/CONTRIBUTING.md) for workflow and quality standards.
54+
See [CONTRIBUTING](https://github.com/SQLoot/.github/blob/main/CONTRIBUTING.md).
7955

80-
## 🔐 Security
56+
## Security
8157

82-
For responsible disclosure, see [SECURITY](https://github.com/SQLoot/.github/blob/main/SECURITY.md).
58+
See [SECURITY](https://github.com/SQLoot/.github/blob/main/SECURITY.md).
8359

8460
---
8561

0 commit comments

Comments
 (0)