Diataxis docs#3843
Conversation
Adds the `br` binary (Dicklesworthstone/beads_rust v0.2.11) alongside `gh` in the server runtime stage. SHA256-pinned, multi-arch (amd64 + arm64). Lets agents running inside the protoMaker server container read/write the `.beads/` issue-tracker store mounted from the host repo. Co-authored-by: Claude Opus 4.7 <noreply@anthropic.com>
…ds (#3836) Follow-up to #3835. The `beads_rust` v0.2.11 amd64 binary is dynamically linked against GLIBC 2.38/2.39, but `node:22-slim` is Debian Bookworm (glibc 2.36) — running `br --version` in the built image fails with: br: /lib/x86_64-linux-gnu/libc.so.6: version `GLIBC_2.38' not found br: /lib/x86_64-linux-gnu/libc.so.6: version `GLIBC_2.39' not found `node:22-trixie-slim` ships glibc 2.41, which satisfies both. Trixie is Debian's current stable. All apt packages we install (gh, gosu, Playwright/Chromium deps, etc.) exist in Trixie. Co-authored-by: Claude Opus 4.7 <noreply@anthropic.com>
Add a how-to walkthrough for driving the board from the CLI and a comprehensive reference covering all command groups and flags. Co-authored-by: Qwen-Coder <qwen-coder@alibabacloud.com>
|
👀 Quinn is reviewing — verdict (PASS / WARN / FAIL) + findings to follow. |
|
Important Review skippedAuto reviews are disabled on base/target branches other than the default branch. 🗂️ Base branches to auto review (2)
Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Plus Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
![protoquinn[bot]](https://avatars.githubusercontent.com/in/3282126?s=60&v=4){kind=small}
There was a problem hiding this comment.
QA Audit — PR #3843 | Diataxis docs
VERDICT: WARN
CI Status
- test: QUEUED
- deploy: QUEUED
- Close external code contributions: SKIPPED
Diff Review
This PR nominally adds two doc pages (how-to/drive-the-board, reference/cli-commands) but also contains Dockerfile changes that are scope creep:
-
New Runtime Dependency —
beads_rustCLI (brv0.2.11): Lines 110–124 install a binary from an external GitHub release. The implementation plan in the PR body only mentions docs; this tool installation appears unrelated and is not mentioned in the acceptance criteria. Whether this ships as part of this PR or a follow-up needs clarification. -
Base Image Flip —
node:22-slim→node:22-trixie-slim: Two occurrences in Dockerfile; likely a separate grooming task. If intentional, it should be called out —trixie-slimis a newer Node 22 variant with a changed toolchain; upgrade risk should be documented in the commit message. -
Documentation Pages: The how-to and reference pages are well-structured and follow the Diataxis pattern. ✅
Observations
- MEDIUM/Scope Creep: Dockerfile install of
beads_rustand base image change are unrelated to the stated doc-only goal. Suggest splitting or removing before merge. - LOW/Clawpatch: Structural review unavailable (
checkout cache failedonmainSHA) — manual review applied instead.
Recommended Action: Either strip the Dockerfile changes and merge docs-only, or expand the PR description to include the toolchain changes. CI must pass before merge.
— Quinn, QA Engineer
|
Submitted REQUEST_CHANGES review on Verdict: WARN — The docs themselves are solid, but the Dockerfile brings in an undocumented |
## Epic: [Epic] Agent integration & docs All child features completed. This PR merges the epic branch into main. ### Features included: - Agent skill teaching the CLI (#3834) - Diataxis docs (#3843) - Make the bin available to agents --- Auto-generated by CompletionDetectorService. <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **Documentation** * Added comprehensive CLI documentation suite covering the protomaker CLI interface for board management, agent lifecycle, and PR workflows, including command reference, skills documentation, and practical how-to guides. * **Chores** * Updated Docker base images to node:22-trixie-slim and integrated beads_rust binary installation for production deployment. <!-- review_stack_entry_start --> [](https://app.coderabbit.ai/change-stack/protoLabsAI/protoMaker/pull/3852?utm_source=github_walkthrough&utm_medium=github&utm_campaign=change_stack) <!-- review_stack_entry_end --> <!-- end of auto-generated comment: release notes by coderabbit.ai -->
](https://app.coderabbit.ai/change-stack/protoLabsAI/protoMaker/pull/3852?utm_source=github_walkthrough&utm_medium=github&utm_campaign=change_stack){kind=link}
1 participant
Summary
Milestone: Agent integration & docs
Add a how-to (drive the board from the CLI) and a reference (full command surface) under docs/, following docs-standard.md.
Acceptance Criteria:
Complexity: small
Guardrails: If this phase involves new or changed behavior, include tests that verify correctness. If this phase adds, removes, or changes a user-facing feature, API endpoint, co...
Created automatically by Automaker