docs(contributor): address PR #1143 review feedback#1145
Conversation
Five fixes against @pdmack's review of the contributor docs rewrite (#1143 (review)): - **Fix broken anchor** in maintaining.md → recipe.md#bom-regeneration (the heading is `## BOM Regeneration`, no `-rule` suffix). - **Document readiness phase** in validator.md. The three container-per-validator phases (deployment, performance, conformance) were already clear, but `readiness` is a first-class ValidationConfig field that uses inline constraint evaluation in `checkReadiness`, not a phase container. Added a note so contributors don't go looking for it under the phase containers. - **Add `pkg/recipe/oskind`** to the index.md package table. Imported by pkg/recipe, pkg/collector, pkg/snapshotter, and the CLI to break a cycle that previously forced OS string constants to be duplicated. - **Clarify merge precedence arrow** in recipe.md. Annotated the arrow with `(lowest priority)` / `(highest priority)` markers and added a one-line note that the arrow is priority, not temporal order — the narrative already said this, but the diagram benefits from the inline hint. - **Drop fragile line-range links** in api-server.md (`middleware.go#L45-L61`, `errors.go#L127`). Both reference source files that get edited frequently and the line range goes stale silently. File-level links are sufficient; the file is small enough that readers can navigate. `make lint` green.
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: ASSERTIVE Plan: Enterprise Run ID: 📒 Files selected for processing (5)
📝 WalkthroughWalkthroughThis PR makes six targeted improvements to contributor documentation files. It adds a new entry for Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Possibly related PRs
Suggested labels
Suggested reviewers
🚥 Pre-merge checks | ✅ 4✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
Coverage Report ✅
Coverage BadgeNo Go source files changed in this PR. |
Summary
Five follow-up fixes against @pdmack's review of #1143 (already merged):
docs/contributor/maintaining.md:62recipe.md#bom-regeneration-rule→recipe.md#bom-regeneration(heading has no `-rule` suffix)docs/contributor/validator.mddocs/contributor/index.mdpackage tabledocs/contributor/recipe.mdmerge-precedence arrowdocs/contributor/api-server.mdMotivation/Context
Follow-up to the contributor docs rewrite (#1143). The five items above were raised in review but the PR had already been merged. This PR resolves the residual feedback.
Fixes: #1143 (review follow-up)
Type of Change
Documentation only.
Components Affected
Testing
Risk Assessment
Low. Doc-only.
Checklist