diff --git a/.changeset/readme-count-it-yourself.md b/.changeset/readme-count-it-yourself.md new file mode 100644 index 0000000000..740c3c0395 --- /dev/null +++ b/.changeset/readme-count-it-yourself.md @@ -0,0 +1,12 @@ +--- +"@objectstack/spec": patch +--- + +docs: make the root README's example-app size claim and package-directory count agree with what they describe (#10320) + +Two numbers on the front door of the repo restated a fact that lived somewhere else, and had already drifted from it: + +- The `examples/app-crm` size blurb hard-coded **31 files, 1,792 lines, roughly 16k tokens**, then handed the reader the exact `find examples/app-crm/src -name '*.ts' -not -name '*.test.ts' | xargs cat | wc -l` command and invited them to verify it under "Count it yourself:". Running that command against `origin/main` returns **1,930 lines**, not 1,792 — a reader who took the invitation got a different number than the one two lines above it. +- The Package Directory's `
` summary claimed **72 published packages**; the table beneath it actually lists **45** rows (a curated set of highlights, not every package — three of those rows are the example apps, whose `package.json` is `"private": true` and never published at all), while the repo's true count of non-private `package.json` files is **69**. + +Rather than re-hardcoding a fresh pair of numbers that will silently drift again at the next merge to `examples/app-crm` or the next row added to the table, both passages now name their own source of truth explicitly and defer to it instead of duplicating it: the CRM blurb states its numbers "as of this writing" and says outright that the command below it, not the sentence, is authoritative; the package-directory summary's count is now the table's actual row count and says the table itself is the source of truth for that count. diff --git a/README.md b/README.md index 23e84eed35..28ea14703d 100644 --- a/README.md +++ b/README.md @@ -142,8 +142,10 @@ in seconds — instead of a silent runtime failure nobody traces back. The other half is size. The bundled example CRM — [`examples/app-crm`](./examples/app-crm): six objects, views, a dashboard, a lead-conversion flow, permission sets, actions, -translations — is **31 files, 1,792 lines, roughly 16k tokens**. That's the whole -example app, in about 8% of a 200k-token context window. Count it yourself: +translations — is **31 files, 1,930 lines, roughly 18k tokens** as of this writing +(about 9% of a 200k-token context window). That's the whole example app. These +counts move as the example evolves — the command below is the source of truth, +not the sentence you just read. Count it yourself: ```bash find examples/app-crm/src -name '*.ts' -not -name '*.test.ts' | xargs cat | wc -l @@ -262,7 +264,7 @@ For the browser, the typed client SDK and React hooks (`useQuery` / `useMutation ## Package Directory
-72 published packages across core, engine, drivers, client, plugins, services, adapters, tools, and examples — click to expand. +45 packages (as of this writing) across core, engine, drivers, client, plugins, services, adapters, tools, and examples — click to expand for the current list, which is the source of truth for this count. ### Core