Skip to content

Commit 15ea214

Browse files
Elon Muskclaude
andauthored
docs(readme): make the "count it yourself" line-count and the package-directory count agree with what they describe (#11012)
The examples/app-crm size blurb hard-coded 31 files, 1,792 lines, roughly 16k tokens and invited the reader to verify it with the find | wc -l command printed right below — running that command against origin/main returns 1,930 lines, not 1,792. The Package Directory summary claimed 72 published packages; the table beneath it actually lists 45 rows (a curated subset, not every package — three of those rows are private, unpublished example apps), against a true count of 69 non-private package.json files repo-wide. Both passages now name their own source of truth explicitly instead of re-asserting a competing hand-typed figure that drifts again at the next merge: the CRM blurb states its numbers "as of this writing" and says the command below it is authoritative, not the sentence; the package-directory summary's count is now the table's actual row count and says the table is the source of truth for it. Fixes #10320 Claude-Session: https://claude.ai/code/session_019bmVFqoQPq63zhKrxdYG1r Co-authored-by: Claude <noreply@anthropic.com>
1 parent 35ad326 commit 15ea214

2 files changed

Lines changed: 17 additions & 3 deletions

File tree

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
---
2+
"@objectstack/spec": patch
3+
---
4+
5+
docs: make the root README's example-app size claim and package-directory count agree with what they describe (#10320)
6+
7+
Two numbers on the front door of the repo restated a fact that lived somewhere else, and had already drifted from it:
8+
9+
- 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.
10+
- The Package Directory's `<details>` 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**.
11+
12+
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.

README.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -142,8 +142,10 @@ in seconds — instead of a silent runtime failure nobody traces back.
142142

143143
The other half is size. The bundled example CRM — [`examples/app-crm`](./examples/app-crm):
144144
six objects, views, a dashboard, a lead-conversion flow, permission sets, actions,
145-
translations — is **31 files, 1,792 lines, roughly 16k tokens**. That's the whole
146-
example app, in about 8% of a 200k-token context window. Count it yourself:
145+
translations — is **31 files, 1,930 lines, roughly 18k tokens** as of this writing
146+
(about 9% of a 200k-token context window). That's the whole example app. These
147+
counts move as the example evolves — the command below is the source of truth,
148+
not the sentence you just read. Count it yourself:
147149

148150
```bash
149151
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
262264
## Package Directory
263265

264266
<details>
265-
<summary><b>72 published packages</b> across core, engine, drivers, client, plugins, services, adapters, tools, and examples — click to expand.</summary>
267+
<summary><b>45 packages</b> (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.</summary>
266268

267269
### Core
268270

0 commit comments

Comments
 (0)