Skip to content

[finding] quickstart Path B publishes a machine-variable compile timing as a literal #249

Description

@claude

Observation-class finding, filed unassigned while working #141 (PR #248). No action requested.

content/docs/quickstart.mdx's Path B sample block publishes a compile timing as a literal:

  ✓ Build complete (72ms)

Every other visible byte in both sample blocks is deterministic — Data: 1 Objects 3 Fields, Artifact: … (1.9 KB), the URL rows, the summary group. This one is not: it is whatever the transcribing machine happened to measure. It was 117ms when PR #143 transcribed it at 17.1.0 and 72ms when I re-transcribed it at 17.2.0, on the same page, with no behavioural change behind the difference.

Two small consequences, neither urgent:

  1. It is the one number on the page a reader cannot reproduce. The two declaration sentences carefully name what each block omits and note that paths are printed expanded, but neither says a timing varies. A reader whose scaffold compiles in 300ms has no way to know that is expected rather than a symptom.
  2. It churns [finding] quickstart carries three version-pinned claims that go stale the day the next CLI publishes — one of them must be deleted, not updated #141's diff on every round. [finding] quickstart carries three version-pinned claims that go stale the day the next CLI publishes — one of them must be deleted, not updated #141 re-boots and re-transcribes both blocks at each CLI publish. The timing will differ every time, so each round produces a one-line change that looks like drift and is not. That is a small but real cost to a card whose entire purpose is separating genuine drift from noise — the same distinction [finding] quickstart carries three version-pinned claims that go stale the day the next CLI publishes — one of them must be deleted, not updated #141's own dispatch is built around.

Options, roughly in increasing order of intervention:

  • Leave it. It is cosmetic and obviously a timing.
  • Declare it — extend Path B's declaration sentence to say the compile timing is whatever your machine measures, alongside the omissions it already names.
  • Elide it — publish ✓ Build complete without the parenthetical, and declare that the CLI prints a duration there. This is the only option that also removes the per-round churn.

I did not do any of these in PR #248, because #141's scope is quickstart.mdx's pins, blocks and port sentence, and this is a question about page style rather than a stale claim. Raising it so the choice is made deliberately rather than re-litigated each time the card fires.

Back-links: #141, #248, #143.


Generated by Claude Code

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationpm:queue

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions