Skip to content

docs: Revise public profile README to list repositories and delivery … #5

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
miccy merged 2 commits into from
Mar 3, 2026
Merged

docs: Revise public profile README to list repositories and delivery … #5

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
879f249
docs: Revise public profile README to list repositories and delivery …
miccy Mar 3, 2026
751ec5d
docs: Refactor profile README repository links table and update root …
miccy Mar 3, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
45 changes: 43 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,46 @@
# .github
Special GitHub repo for organization health files ✨
# SQLoot `.github`

Public organization-health repository for SQLoot.

## Purpose

This repository defines public defaults used across SQLoot repositories:

- community policy files (`CODE_OF_CONDUCT.md`, `CONTRIBUTING.md`, `SECURITY.md`, `SUPPORT.md`)
- issue and pull request templates
- workflow templates for new repositories
- organization profile content (`profile/README.md`)
- shared ownership baseline (`CODEOWNERS`)

## Repository structure

```text
.
├── .github/
│ └── dependabot.yml
├── ISSUE_TEMPLATE/
├── workflow-templates/
├── profile/
│ └── README.md
├── CODEOWNERS
├── CODE_OF_CONDUCT.md
├── CONTRIBUTING.md
├── FUNDING.yml
├── PULL_REQUEST_TEMPLATE.md
├── SECURITY.md
└── SUPPORT.md
```
Comment on lines +17 to +32

@coderabbitai coderabbitai Bot Mar 3, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🔴 Critical

🧩 Analysis chain

🏁 Script executed:

#!/bin/bash
# Ověření struktury .github/ adresáře

echo "=== Kontrola existence .github/ adresáře ==="
if [ -d ".github" ]; then
  echo "✓ .github adresář existuje"
else
  echo "✗ .github adresář neexistuje"
  exit 1
fi

echo ""
echo "=== Kontrola podadresářů ==="
for dir in "ISSUE_TEMPLATE" "workflow-templates" "profile"; do
  if [ -d ".github/$dir" ]; then
    echo "✓ .github/$dir existuje"
  else
    echo "✗ .github/$dir chybí"
  fi
done

echo ""
echo "=== Kontrola souborů v .github/ ==="
for file in "CODEOWNERS" "CODE_OF_CONDUCT.md" "CONTRIBUTING.md" "PULL_REQUEST_TEMPLATE.md" "SECURITY.md" "SUPPORT.md"; do
  if [ -f ".github/$file" ]; then
    echo "✓ .github/$file existuje"
  else
    echo "✗ .github/$file chybí"
  fi
done

echo ""
echo "=== Kontrola profile/README.md ==="
if [ -f ".github/profile/README.md" ]; then
  echo "✓ .github/profile/README.md existuje"
else
  echo "✗ .github/profile/README.md chybí"
fi

echo ""
echo "=== Skutečná stromová struktura .github/ ==="
tree .github -a --charset ascii 2>/dev/null || find .github -type f -o -type d | sort | sed 's|^\./||' | sed 's|[^/]*/|  |g'

Repository: SQLoot/.github

Length of output: 640

Struktura souborů v ASCII stromu neodpovídá skutečnosti.

ASCII strom v řádcích 17-29 dokumentuje strukturu, která v repozitáři neexistuje. Adresář .github/ obsahuje pouze dependabot.yml, všechny uvedené podadresáře (ISSUE_TEMPLATE/, workflow-templates/, profile/) a soubory (CODEOWNERS, CODE_OF_CONDUCT.md, CONTRIBUTING.md, PULL_REQUEST_TEMPLATE.md, SECURITY.md, SUPPORT.md) chybí. Opravte ASCII strom tak, aby odpovídal skutečné struktuře repozitáře.

🤖 Prompt for AI Agents 
Verify each finding against the current code and only fix it if needed.

In `@README.md` around lines 17 - 29, The ASCII tree under the README that shows
`.github/` is inaccurate; update the ASCII diagram (the block containing
`.github/` and its subentries) to reflect the repository's real `.github`
contents (it currently only contains `dependabot.yml`) by removing the listed
subfolders and files (ISSUE_TEMPLATE/, workflow-templates/, profile/,
CODEOWNERS, CODE_OF_CONDUCT.md, CONTRIBUTING.md, PULL_REQUEST_TEMPLATE.md,
SECURITY.md, SUPPORT.md) and replacing them with the actual entry
`dependabot.yml` (or any other real items if present) so the README's tree
matches the repo.


## Operating rules

- Keep everything public-safe (no internal links, no private roadmap details, no operational secrets).
- Treat changes as org-wide defaults; update with explicit, reviewable edits.
- Keep templates aligned with active delivery priorities in public repos.

## Related repositories

- Public profile: [`profile/README.md`](./profile/README.md)
- Internal-only counterpart: `SQLoot/.github-private`

---

Expand Down
88 changes: 32 additions & 56 deletions profile/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,83 +3,59 @@
</div>

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

<p align="center">
<img src="https://img.shields.io/badge/Public_rollout-WIP-f59e0b?style=flat-square" alt="Public rollout WIP" />
<img src="https://img.shields.io/badge/Built_on-Evolu-1f6feb?style=flat-square" alt="Foundation Evolu" />
<img src="https://img.shields.io/badge/Compatibility-SQLite-0ea5e9?style=flat-square" alt="SQLite compatibility" />
<img src="https://img.shields.io/badge/Bun-v1.3.10-111827?style=flat-square&logo=bun&logoColor=white" alt="Bun-first runtime" />
<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" />
</p>

## ⚡ Why SQLoot
## Why SQLoot

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

## 🤝 Foundation: Evolu
Current strategy:

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.
- keep compatibility with Evolu upstream where it matters
- ship measurable improvements in SQLoot-owned tracks
- expose benchmark evidence and operational runbooks publicly

- Upstream project: [evoluhq/evolu](https://github.com/evoluhq/evolu)
- Upstream docs: [evolu.dev](https://www.evolu.dev)
- SQLoot baseline fork: [SQLoot/evolu-plan-b](https://github.com/SQLoot/evolu-plan-b)

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.

## 🧱 What SQLoot Is Building
## Repository Links

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

Public docs and public APIs are opening in phases as each track stabilizes.
## 2026 Delivery Priorities

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

### Milestone Progress (as of March 1, 2026)
## Foundation: Evolu

- [x] 📦 Public track for `evolu-plan-b` prepared (100%)
- [x] 🧩 Evolu-based Bun-first baseline established (95%)
- [ ] 🔌 Priority integrations (TanStack Start, Tauri, Astro) (75%)
- [ ] 🧪 Benchmark harness foundation in `bench-suite` (45%)
- [ ] 📊 Regression evidence gates (p50/p95/throughput/memory) (40%)
- [ ] 🌐 Relay and transport hardening (`relays`, `blind-cloud`) (30%)
- [ ] 🧱 SQLoot core bootstrap (`core`) (20%)
- [ ] 🛠️ `lootbox` CLI baseline (scope, commands, packaging) (25%)
- [ ] 📚 Public docs and evidence surfaces (`website`, `local-first`) (35%)

## 🎯 Next 4 Weeks
- Upstream project: [evoluhq/evolu](https://github.com/evoluhq/evolu)
- Upstream docs: [evolu.dev](https://www.evolu.dev)

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

## 🤝 Contributing
## Contributing

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

## 🔐 Security
## Security

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

---

Expand Down