docs: site build also adds a missing label; the brief and the command line say so - #766
Merged
Merged
Conversation
The site chapter's opening and the public one-line description of `abcd site build` both said the build writes only inside the directory it is given. Since the build completes a ui.json that lacks a declared label (addMissingLabels, called from Build unless LeaveUI), it also writes that one file outside the output directory. The chapter's Behaviour section already records the exception; the opening now matches it, and the manifest sentence (regenerated into the CLI reference, the surface snapshot and `site build --help`) names the label write. Found by the v0.12.0 docs review at df8815a. Assisted-by: Claude:claude-opus-5-5
The comment beside drain's help placement said the verb's one form is a dry run until the run is built. The run form exists: each invocation performs one move and names the run an agent drives. The comment now says so; the placement itself is unchanged. Assisted-by: Claude:claude-opus-5-5
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The v0.12.0 docs review found two sentences that say
abcd site buildwrites only inside the output directory it is given. Since the build learned to add a missing label to the site's ui.json, that is no longer true: it also writes that one file, and only when a declared label is absent.This change corrects both sentences:
site buildnow reads "Writes there, plus a missing label into site-src/ui.json". It is generated into the CLI reference, the release surface snapshot and the command's own help, all regenerated here.A second commit rewrites a stale code comment beside drain's help placement, which said the verb could only do a dry run. It can also run; only the comment changes.
Checks run: record-lint, docs-lint and site-render pass; the surface, core surface and release tests pass with the CI environment set; the docs fidelity report shows every shipped surface covered by a chapter. The docs review needs a fresh run at this head before the release cut.
Assisted-by: Claude:claude-opus-5-5