Skip to content

v2: a shorter README for users - #163

Merged
kvignesh1420 merged 2 commits into
v2from
v2-readme
Nov 9, 2026
Merged

kvignesh1420 merged 2 commits into
v2from
v2-readme

Conversation

@kvignesh1420

Copy link
Copy Markdown
Collaborator

The README was a 778-line reference manual. It is now 364 lines, ordered by what a user needs first, and points to examples/ for the details.

Structure:

  1. Header, results, updates and citation: unchanged.
  2. Overview: three sentences, plus the framework figure. This also fixes the broken #write-your-own-tables link.
  3. Installation: shorter.
  4. Quickstart: three self-contained examples, each also run on its own in CI:
    • random databases from SchemaPrior, saved for relbench, plus the corpus command;
    • one table;
    • a small database, saved.
  5. One short section per task: build a table (the two reference tables), link tables (one example and an options table), start from real rows, author families (realize versus sample), random tables and databases, save and inspect, reproducibility.
  6. Latency and memory: the key numbers.
  7. Development.

What moved out: the detailed reference now links to the runnable scripts in examples/concepts/ instead of sitting inline: latent versus recorded values, how foreign-key options combine, count and fill rules, calibration details, Scaled shapes, save semantics and the low-level graph. Dropped as no longer useful to users: the migration note for earlier unreleased v2 commits, and "Go lower", which pointed at internal classes.

The anchors that other files link to (#build-a-table, #author-many-tables-from-one-description) are kept, and every relative link resolves. pixi run examples passes: 9 blocks run together and 3 also run on their own.

@kvignesh1420
kvignesh1420 merged commit 462b882 into v2 Nov 9, 2026
5 checks passed
@kvignesh1420
kvignesh1420 deleted the v2-readme branch November 9, 2026 05:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant