Repository navigation
docs: restore README - #7
Merged
Merged
Conversation
a36c960 ("initial") replaced README.md with the single word "hello", dropping 89 lines. It reads like an accidental re-init rather than an intentional removal — nothing else in that commit, and the content it removed is still referenced elsewhere (docs/ONBOARDING.md and docs/RECIPE_CONTRACT.md are pointed at from it, not the other way round). Restores the version from 5cdd3c1 with two sentences updated for the Postgres migration: the registry is no longer filesystem-truth, and `labctl serve` reads that registry rather than building an in-memory SQLite cache from the run tree. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
maharajamihir
force-pushed
the
mihir/restore-readme
branch
from
August 17, 2026 17:54
1d5e5ee to
60235dc
Compare
avocadoali
approved these changes
Aug 17, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
README.mdonmainis currently one word:a36c960 ("initial")replaced it with that, dropping 89 lines —1 insertion(+), 89 deletions(-), and nothing else in the commit. It looks like an accidental re-init rather than a deliberate removal: the content it dropped is what points atdocs/ONBOARDING.md,docs/RECIPE_CONTRACT.mdandexamples/, and those docs are still current.This restores the last good version (
5cdd3c1) — install/quick-start, thelabctl initmode table, architecture, and the workflow philosophy section.Two sentences I changed rather than restoring verbatim
The old text predates the Postgres migration, so a faithful restore would reintroduce stale claims:
runs_base/is the source of truth and that "labctl serve… builds an in-memory SQLite cache from the tree on startup". Now: Postgres is truth for run state/aliases/dedup/pipelines, the filesystem holds the bulk data runs produce, andserveis read-only over that registry.Verified against the current source:
store.rsis "Async-native facade overPgStore" andserver::serve(cluster, store.pg(), addr)takes anArc<PgStore>.Everything else is restored as-is. (Unrelated leftover:
main.rs:959still has a "filesystem-truth registry" comment — left alone to keep this docs-only.)🤖 Generated with Claude Code