Public/preparation by miccy · Pull Request #4 · SQLoot/.github

miccy · 2026-03-01T16:53:19Z

This pull request makes a major update to the profile/README.md to provide a more comprehensive and visually engaging project overview. The README now includes branding, project tracks, roadmap, and clearer contribution and security guidelines. These improvements help new contributors and users quickly understand the project's goals, current status, and how to get involved.

Project overview and branding:

Added a banner image, badges, and a short description highlighting SQLoot’s local-first focus, foundation, and compatibility.
Expanded the introduction to explain SQLoot’s goals, foundation on Evolu, and upstream relationships.

Project tracks and roadmap:

Added a detailed table outlining all major tracks, their roles, and current states, plus a milestone roadmap with progress indicators for 2026.
Listed next steps for the coming 4 weeks, making priorities and upcoming work clear.

Contributor and security guidance:

Improved sections for contributing and responsible security disclosure, with direct links to relevant documentation.

Maintenance and credits:

Summary by CodeRabbit

Poznámky k vydání

Dokumentace
- Vylepšena stránka profilu projektu s novým bannerem a položkami odznamů.
- Přidána sekce "Proč SQLoot" s klíčovými body a vylepšeným popisem projektu.
- Zavedena nová sekce "Příštích 4 týdny" s konkrétními akčními položkami.
- Aktualizovány informace o údržbě a sponzorství projektu.

…w branding.

…iorities in README.

Copilot

Pull request overview

This PR refreshes the organization profile README to provide a more detailed, branded overview of SQLoot (tracks, roadmap, contribution/security links) and adds a new banner SVG asset used by the profile.

Changes:

Reworked profile/README.md with banner, badges, expanded project overview, tracks table, and 2026 roadmap/near-term priorities.
Added branding/sqloot-banner.svg and referenced it from the profile README.

Reviewed changes

Copilot reviewed 1 out of 2 changed files in this pull request and generated 1 comment.

File	Description
profile/README.md	New branded org profile content (banner, badges, tracks, roadmap, contribution/security links).
branding/sqloot-banner.svg	New banner SVG used by the org profile README.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Signed-off-by: Miccy <code@miccy.dev>

coderabbitai

Actionable comments posted: 1

🧹 Nitpick comments (1)

profile/README.md (1)
38-51: Zvažte standardizaci terminologie stavů.

Tabulka používá 7 různých označení stavů: "Public rollout", "Planning", "WIP", "Research", "TBD", "Private", "Internal". Pro lepší přehlednost zvažte:

Redukci na 3-4 konzistentní stavy (např. Planning → Research → WIP → Public)

Přidání legendy vysvětlující jednotlivé stavy

Současná implementace je funkční, ale standardizace by zlepšila čitelnost.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@profile/README.md` around lines 38 - 51, Tabulka používá příliš mnoho
nejednotných stavů; upravte obsah v README tak, aby všechny řádky (např. tracky
`evolu-plan-b`, `core`, `bench-suite`, `relays`, `lootbox`, `blind-cloud`,
`local-first`, `loot-cms`, `loot-ops`, `website`, `knowledge`) používaly jen 3–4
konzistentní stavy (navrženě: Planning, Research, WIP, Public) a vytvořte
krátkou legendu nad nebo pod tabulkou vysvětlující každý stav a jaké původní
označení mu odpovídá (např. mapování: Planning ← Planning, Research ←
Research/TBD, WIP ← WIP, Public ← Public rollout/Private/Internal pokud vhodné),
aby byla terminologie jednotná a čitelná.

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@profile/README.md`:
- Around line 30-32: The README contains a broken external link
"SQLoot/evolu-plan-b" in the upstream/links bullet list; open the README section
that lists "- SQLoot/evolu-plan-b" and either remove that bullet or replace the
link text and URL with a valid public repository under the SQLoot account (for
example "SQLoot/evolu" and its corresponding GitHub URL), ensuring the markdown
link syntax and surrounding bullets remain consistent.

---

Nitpick comments:
In `@profile/README.md`:
- Around line 38-51: Tabulka používá příliš mnoho nejednotných stavů; upravte
obsah v README tak, aby všechny řádky (např. tracky `evolu-plan-b`, `core`,
`bench-suite`, `relays`, `lootbox`, `blind-cloud`, `local-first`, `loot-cms`,
`loot-ops`, `website`, `knowledge`) používaly jen 3–4 konzistentní stavy
(navrženě: Planning, Research, WIP, Public) a vytvořte krátkou legendu nad nebo
pod tabulkou vysvětlující každý stav a jaké původní označení mu odpovídá (např.
mapování: Planning ← Planning, Research ← Research/TBD, WIP ← WIP, Public ←
Public rollout/Private/Internal pokud vhodné), aby byla terminologie jednotná a
čitelná.

ℹ️ Review info

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 4af1c00 and 43a414c.

⛔ Files ignored due to path filters (1)

branding/sqloot-banner.svg is excluded by !**/*.svg

📒 Files selected for processing (1)

profile/README.md

coderabbitai · 2026-03-01T16:57:34Z

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 4af1c00 and b5f8cd2.

⛔ Files ignored due to path filters (1)

branding/sqloot-banner.svg is excluded by !**/*.svg

📒 Files selected for processing (1)

profile/README.md

📝 Walkthrough

Walkthrough

Aktualizace profilu README.md zahrnuje přepracování struktury s novými HTML bannery, ikonami a reorganizovaným obsahem. Změny zahrnují přidání nových sekcí, aktualizaci informací o údržbě a vylepšení vizuální prezentace projektových informací.

Changes

Cohort / File(s)	Summary
Profile Documentation `profile/README.md`	Přidán HTML banner s ikonami; rozšířeny sekce "Why SQLoot", "Foundation: Evolu" a "What SQLoot Is Building"; nově přidána sekce "Next 4 Weeks"; aktualizovány údaje o údržbě projektu (změna od ownCTRL na miccy).

Estimated code review effort

🎯 2 (Jednoduchá) | ⏱️ ~10 minut

Poem

🐰 Hop, skip, and a bound through README so grand,
New banners and badges across the land,
With SQLoot's vision shining so bright,
This documentation now feels just right! ✨

✨ Finishing Touches

🧪 Generate unit tests (beta)

Create PR with unit tests
Post copyable unit tests in a comment
Commit unit tests in branch public/preparation

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

miccy added 2 commits March 1, 2026 17:24

feat: add SVG project banner and update GitHub profile README with ne…

f7c000a

…w branding.

docs: Update project vision, track details, roadmap, and immediate pr…

43a414c

…iorities in README.

miccy requested a review from Copilot March 1, 2026 16:53

miccy self-assigned this Mar 1, 2026

miccy added documentation Improvements or additions to documentation audit Repo security audit labels Mar 1, 2026

Copilot started reviewing on behalf of miccy March 1, 2026 16:53 View session

Copilot AI reviewed Mar 1, 2026

View reviewed changes

Comment thread profile/README.md Outdated

Update profile/README.md

b5f8cd2

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Signed-off-by: Miccy <code@miccy.dev>

coderabbitai Bot reviewed Mar 1, 2026

View reviewed changes

Comment thread profile/README.md

SQLoot deleted a comment from coderabbitai Bot Mar 1, 2026

miccy merged commit 4232477 into main Mar 1, 2026
1 check was pending

miccy deleted the public/preparation branch March 1, 2026 16:58

coderabbitai Bot mentioned this pull request Mar 3, 2026

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

Merged

Navigation Menu

Uh oh!

Public/preparation - #4

Public/preparation#4
miccy merged 3 commits into
mainfrom
public/preparation

miccy commented Mar 1, 2026 •

edited by coderabbitai Bot

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

coderabbitai Bot left a comment

Uh oh!

Uh oh!

coderabbitai Bot commented Mar 1, 2026 •

edited

Loading

Review failed

Walkthrough

Changes

Estimated code review effort

Poem

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Uh oh!

Conversation

miccy commented Mar 1, 2026 • edited by coderabbitai Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Poznámky k vydání

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

coderabbitai Bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

coderabbitai Bot commented Mar 1, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Review failed

Walkthrough

Changes

Estimated code review effort

Poem

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

miccy commented Mar 1, 2026 •

edited by coderabbitai Bot

Loading

coderabbitai Bot commented Mar 1, 2026 •

edited

Loading