Skip to content

Commit f25bb18

Browse files
claude[bot]claude
andauthored
docs(cli): name the fixture the os compile / os info transcripts were run against (#9430) (#9624)
Both sample blocks in cli.mdx's Build & Validate section print `2 Objects 6 Fields` / `1 Views 1 Actions` / `3 plugins`, and the `os info` block also names `my_app_note` and `my_app_ticket`. Nothing on the page says where that project comes from: the page's own walkthrough builds a DIFFERENT fixture (`os generate object customer` / `action approve` / `flow onboarding`), which would print `my_app_customer` and a `Logic:` row. A reader who follows the page cannot reproduce the transcripts and has no way to tell whether the page or their own run is wrong. No printed value changes — the transcripts are verified against real runs (#9092/#9151 for `os compile`, #9342/PR #9429 for `os info`) and this is a pure insertion. What is added is the provenance those runs had and the page did not: * a Callout under the `os info` block naming the whole fixture — `npm create objectstack@latest my-app` (the `blank` starter: two-field `my_app_note`, three connector plugins) plus the four-field ticket object, the view and the action listed in build-with-claude-code.mdx, renamed out of `support_desk_` into `my_app_`, with that page's `support` app deliberately left out; * why the `UI:` row carries no `Apps` (printMetadataStats drops zero counts, packages/cli/src/utils/format.ts); * which lines are NOT fixture identity: timings are machine identity, the author-time rule count and artifact size track the CLI version; * one line under the `os compile` block pointing at that note, since its counts come from the same fixture and had the same gap. Every component of the counts is checkable in-tree: the blank template's note.object.ts (2 fields) and its three connector plugins, the ticket listing's 4 fields, one view, one action, and the scaffolder's namespace rewrite (rewrite-identity.ts) that makes `blank_note` read `my_app_note`. Claude-Session: https://claude.ai/code/session_01XqDQYVU5smx29ts9pAErja Co-authored-by: Claude <noreply@anthropic.com>
1 parent 5f99739 commit f25bb18

1 file changed

Lines changed: 20 additions & 0 deletions

File tree

content/docs/deployment/cli.mdx

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -418,6 +418,9 @@ os compile --json # JSON output for CI pipelines
418418
Artifact: dist/objectstack.json (7.6 KB)
419419
```
420420

421+
Those counts are from a sample project, named in full under [`os info`](#os-info)
422+
below — the same fixture backs both output examples.
423+
421424
The resulting `dist/objectstack.json` is a **portable, self-describing deployment unit**
422425
you can hand it to `os start` (locally or on a server), publish it to a CDN, or fetch it
423426
over HTTP from another runtime. See [`os start`](#os-start) and
@@ -509,6 +512,23 @@ os info --json # JSON output for tooling
509512
Loaded in 59ms
510513
```
511514

515+
<Callout type="info">
516+
**The project behind these counts.** The `os compile` and `os info` examples above were
517+
run against one fixture, so the numbers can be rebuilt and checked rather than taken on
518+
trust: the project this page scaffolds in
519+
[Your First App in 2 Minutes](#your-first-app-in-2-minutes)
520+
`npm create objectstack@latest my-app`, whose `blank` starter supplies the two-field
521+
`my_app_note` object and the three connector plugins — plus the four-field ticket object,
522+
the view and the action listed under
523+
[Build with Claude Code](/docs/getting-started/build-with-claude-code#3-what-claude-code-writes),
524+
renamed out of that page's `support_desk_` namespace into `my_app_`. That page's `support`
525+
app is **not** added, and a zero count is never printed, which is why the `UI:` row reads
526+
`1 Views 1 Actions` with no `Apps`. The walkthrough's `os generate` commands are **not**
527+
part of the fixture — run those as well and the summary gains `my_app_customer` and a
528+
`Logic:` row. Timings are machine identity, and the rule count and artifact size track the
529+
CLI version; everything else is fixture identity and reproduces.
530+
</Callout>
531+
512532
### Schema migrations
513533

514534
The metadata→database sync is **additive-only**: on boot it creates missing

0 commit comments

Comments
 (0)