Skip to content

Add Docker and Nix to bencher CLI docs#701

Merged
epompeii merged 2 commits intodevelfrom
u/ep/cli-docs
Mar 13, 2026
Merged

Add Docker and Nix to bencher CLI docs#701
epompeii merged 2 commits intodevelfrom
u/ep/cli-docs

Conversation

@epompeii
Copy link
Member

This changeset adds Docker and Nix usage to the bencher CLI docs.

@epompeii epompeii self-assigned this Mar 13, 2026
@github-actions
Copy link

github-actions bot commented Mar 13, 2026

🤖 Claude Code Review

PR: #701
Base: devel
Head: u/ep/cli-docs
Commit: 726c89e03f1e72731eba674404f34d317348f948


PR Review: Add Docker and Nix installation docs for CLI

Summary

This PR adds Docker and Nix installation sections to the "Install CLI" documentation pages across all 9 supported languages (en, de, es, fr, ja, ko, pt, ru, zh). It introduces 21 new chunk files and modifies 9 content pages.

Positive observations

  • Good component reuse: The shared code snippets (cli-docker.mdx, cli-docker-version.mdx, cli-nix-run.mdx) are properly extracted into language-agnostic shared chunks, with only the prose localized per language. This follows the existing pattern well.
  • Consistent structure: All 9 languages follow the same structure and import pattern, matching existing sections like cli-install-scripts and cli-install-source.
  • Dynamic versioning: The Docker version tag snippet correctly uses BENCHER_VERSION for the pinned version example, consistent with how the rest of the docs handle versioning.

Issues

  1. Section ordering is unexpected: Docker is inserted between GitHub Actions and Source, while Nix is inserted after Source. This creates an order of: Scripts → GitHub Actions → Docker → Source → Nix → Pre-Built Binaries → Packages. A more natural ordering might group all "run without installing" options (Docker, Nix) together, either before or after the "install" options (Scripts, GitHub Actions, Source). Consider whether Docker should come after Source rather than before it.

  2. Nix flake link casing inconsistency: The English chunk (en/cli-install-nix.mdx) uses lowercase "Nix flake" while German (de/cli-install-nix.mdx) uses capitalized "Nix Flake". Other languages vary. This is minor but worth standardizing — "Nix flake" (lowercase "flake") appears to be the canonical form per the Nix documentation.

  3. modified date is in the future: All pages set modified: "2026-03-13T07:00:00Z". Today's date is 2026-03-13, but depending on timezone, this could be considered a future timestamp. This matches the project's existing pattern so it's likely fine, but worth noting.

  4. No security or performance concerns: These are purely documentation changes with no code logic, API changes, or security-sensitive content.

Verdict

This is a clean, straightforward documentation PR. The only substantive feedback is the section ordering question (#1 above) — it's worth confirming the intended placement is deliberate. Otherwise, this looks good to merge.


Model: claude-opus-4-6

@epompeii epompeii merged commit 75f51ca into devel Mar 13, 2026
33 of 34 checks passed
@epompeii epompeii deleted the u/ep/cli-docs branch March 13, 2026 04:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant