docs: remove external runtime repo dependency#425
Conversation
There was a problem hiding this comment.
AI Automated Review
Full PR review.
Analysis engine: MiniMax-M2.7@https://litellm.jory.dev/v1 (anthropic) — escalated (fast_low_confidence)
PR Review: PR 425 — docs: remove external runtime repo dependency
Recommendation
Approve. This PR makes targeted documentation updates to remove required external runtime repository references, aligning with issue PR 401's acceptance criteria.
Change-by-Change Findings
README.md
- Deployment section (Phase 1): Consolidated deployment requirements from 4 bullet points (Dockerfile, K8s manifests, ExternalSecret placeholders, internal-only ingress) into 2 bullets about the Dockerfile and auto-migrations. Removes ExternalSecret as a required pattern.
- Deployment guidance: Changed from a prescriptive reference to a specific Helm chart location (
home-ops/kubernetes/apps/base/llm/dispatch/) to a general statement that Dispatch ships a Dockerfile and orchestration manifests are not included. Added reference to "optional example repos" for the Helm chart—this matches the issue's goal of marking external workflow repos as optional. - Required secrets: Removed the
ExternalSecretannotation, keeping only the essential environment variables.
docs/openclaw-agent-mc-workflow.md
- Pre-Cutover Validation: Replaced specific smoke checklist commands (pointing to
scripts/smoke-checklist.mjs) with a description that the checklist documents 14 verification steps. This removes the reference to an external script location and provides a general overview of what the checklist covers.
Standards Compliance
- ✅ Changes align with the repository's documented tech stack (Debian bookworm-slim, Dockerfile-based deployment).
- ✅ No agent-specific names introduced in generic docs.
- ✅ The
docs/openclaw-agent-mc-workflow.mdfile already carries a historical notice at the top directing readers to the canonicaldocs/worker-execution-contract.md. - ✅ No code standards violations; changes are documentation-only.
Linked Issue Fit
Issue PR 401 acceptance criteria checked:
- "Audit docs for references to required external prompt/script repos" — ✅ Verified. The PR removes reference to the
scripts/smoke-checklist.mjscommand and external repo paths. - "Move required contract docs into Dispatch" — ✅ The smoke checklist is already in
docs/smoke-checklist.mdwithin the repo; this PR updates the reference to not require running external commands. - "Mark external workflow repos as optional examples only" — ✅ The README now states example Kubernetes manifests are "available in optional example repos," not required.
- "Keep harness-specific examples small and non-authoritative" — ✅ The deployment guidance no longer treats the Helm chart manifests as the authoritative deployment method.
Evidence Provider Findings
No evidence providers were configured for this review.
Tool Harness Findings
The preliminary review provided a reasonable summary of the changes. No discrepancies found between the tool findings and the actual diff.
CI Check Results
- ✅ Docker Build: success
- ✅ Validate: success
Unknowns or Needs Verification
None. This is a pure documentation change that can be fully verified against the diff and existing repository conventions. No version bumps, code changes, or security-sensitive modifications are present.
Closes #401