Skip to content

Apply the word rules to the site text - #96

Merged
clhodapp merged 3 commits into
mainfrom
docs/apply-word-rules
Nov 12, 2026
Merged

Apply the word rules to the site text#96
clhodapp merged 3 commits into
mainfrom
docs/apply-word-rules

Conversation

@clhodapp

@clhodapp clhodapp commented Nov 11, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

Applies the workspace word and phrasing rules to the text of the site: the docs pages, the landing page, the brand README, CSS comments and SVG comments.

  • "in force" is replaced by the mechanism: "for each system its parent evaluates its children for", "the package set selection that applies to the manifest", "evaluated for several systems".
  • "beneath" is now "declared inside". "tree" naming the flake is now "flake"; plain senses (source tree, working tree, pinned trees, the tree of manifests) stay.
  • "twin" is now "the WithEcosystemArgs variant".
  • "own" as an intensifier, "the X one", "fleet", "mirror" outside the nixpkgs.lib mirror, "projection", "the fold", "family", em-dashes, "(not ...)" asides, ", never" contrasts, "your flake", "eliminate", "carry"/"serve"/"arrive" for data flow and "at any depth" / "reaches every" claims are rewritten.
  • The heading "The fold" in the composition deep dive is now "Applying the overlays"; no page links to its anchor.
  • "top" naming the configuration that publishes the outputs is now "caisson top" in full ("a flakeless caisson top", "a structural caisson top"), and "at a flake top" is now "in a flake". The argument top of mkIntegration, topValue and mkTopConfiguration keep their names.

The option descriptions in docs/reference/options.md quote caisson's option text. They use the same vocabulary as the caisson sweep (nix-caisson/caisson#150); any wording the two PRs settle differently gets aligned before merging.

nix flake check passes locally (the site package builds with mdBook, and the formatting check passes).

🤖 Generated with Claude Code

@clhodapp @claude
docs: apply the word rules to the site text
8c16020 
Name the mechanism where the pages said "in force", write "declared
inside" for "beneath", "flake" for a tree that names the flake, and
"the WithEcosystemArgs variant" for "twin". Drop "own" as an
intensifier, write the noun where "one" stood for it, and remove
"fleet", "mirror" outside the nixpkgs.lib mirror, "projection",
"the fold", em-dashes, "(not ...)" asides and ", never" contrasts.
The reworded option descriptions follow the caisson sweep.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@clhodapp clhodapp self-assigned this Nov 11, 2026
clhodapp and others added 2 commits November 11, 2026 15:31
@clhodapp @claude
docs: name configurations and evaluation results in place of machines…
213a9ad 
… and views

Name the NixOS, nix-darwin or system-manager configuration in full
where the reference, the option pages and the concept pages said
"machine" for a configuration, and keep "machine" and "computer" for
the computer a system runs on. Describe the childless evaluation and
the full evaluation in place of the childless and full views, and
write "evaluation result" where a page means what evaluating a
configuration returns. Say that caisson, not a parent configuration,
finalizes a deferred configuration.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@clhodapp @claude
docs: write caisson top in full
505ef62 
The library and option references name the caisson top in full, and a
flake is called a flake where the sentence is about one.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@clhodapp
clhodapp merged commit b610662 into main Nov 12, 2026
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

@clhodapp clhodapp

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@clhodapp