docs(agents): add Documentation Impact Evaluation section and refresh stale references#269
Conversation
Greptile SummaryThis documentation-only PR adds a "Documentation Impact Evaluation" section (§5) to both All new cross-references in the added table point to files that exist in the repo ( Confidence Score: 4/5Safe to merge functionally; one unresolved reference from a prior review thread (docs/reference/node-labels.md does not exist) remains in the "When in doubt" section. All new content introduced in this PR is accurate and internally consistent — every path cited in the new Documentation Impact Evaluation table was verified to exist in the repository. Score is 4 rather than 5 because a broken cross-reference (docs/reference/node-labels.md) flagged in a prior review thread persists unchanged in both files and has not been resolved. Both AGENTS.md and .claude/CLAUDE.md retain the unresolved docs/reference/node-labels.md reference in the "When in doubt" section. Important Files Changed
Flowchart%%{init: {'theme': 'neutral'}}%%
flowchart TD
A[PR ready for pre-push qualification] --> B{Evaluate documentation impact}
B --> C{Change type?}
C --> D[New/changed/removed provider]
C --> E[New/changed/removed engine]
C --> F[Chart values schema change]
C --> G[API endpoint / config schema change]
C --> H[New invariant or load-bearing surface]
C --> I[Makefile target / repo-layout change]
C --> J[None of the above]
D --> D1["docs/providers/name.md + docs/overview.md + Choosing a Provider table"]
E --> E1["docs/engines/engine.md"]
F --> F1["charts/topograph/values.yaml comments + NOTES.txt + referencing docs"]
G --> G1["docs/api.md"]
H --> H1["AGENTS.md + .claude/CLAUDE.md (same PR)"]
I --> I1["AGENTS.md + .claude/CLAUDE.md (same PR)"]
J --> J2[Review for collateral drift]
D1 & E1 & F1 & G1 & H1 & I1 & J2 --> K[make qualify]
K --> L[Submit PR]
Reviews (2): Last reviewed commit: "docs(agents): add Documentation Impact E..." | Re-trigger Greptile |
| | Change | Docs update required | | ||
| |---|---| | ||
| | New / changed / removed provider | `docs/providers/<name>.md` + `docs/overview.md` provider list + "Choosing a Provider" scenario table | | ||
| | New / changed / removed engine | `docs/engines/<engine>.md` | |
There was a problem hiding this comment.
Broken cross-reference:
docs/reference/node-labels.md does not exist
The new Documentation Impact Evaluation table points contributors to docs/reference/node-labels.md, but neither that file nor the docs/reference/ directory exists in the repository at this commit (confirmed via git ls-tree of the PR HEAD). The commits that created this file (2bb926c, 4480ab4) are present in the git object store but on a branch that has never been merged to main. The PR description asserts "All cross-references verified against current main," but this reference is unresolvable today. A contributor updating label semantics will hunt for a file they cannot find.
| | New / changed / removed engine | `docs/engines/<engine>.md` | | |
| | New / changed label or annotation key | `docs/reference/node-labels.md` (create if it does not yet exist) | |
|
|
||
| Every PR should be evaluated for documentation impact before pre-push qualification. The following changes imply specific doc updates in the same PR: | ||
|
|
||
| | Change | Docs update required | |
There was a problem hiding this comment.
Broken cross-reference: "Exposing the Topograph API" section does not exist in
docs/engines/k8s.md
The table directs contributors updating Ingress, HTTPRoute, NetworkPolicy, or ServiceMonitor templates to docs/engines/k8s.md "Exposing the Topograph API" section. That section does not exist — docs/engines/k8s.md has headings for Overview, Use of Topograph, Configuration, and Validation and Testing only. The Helm chart already ships charts/topograph/templates/ingress.yaml and charts/topograph/templates/servicemonitor.yaml, so this is an active code path with no matching documentation target. Contributors updating those templates will find no such section.
Consider either removing the quoted section name until the section is written, or pointing at the existing ## Configuration heading as a temporary target.
… stale references Builds on the agent-guidance pattern established in NVIDIA#253, adding the explicit evaluation guidance that was deferred during that PR's review. Adds: - New "Documentation Impact Evaluation" subsection in §5 with a table mapping change types to the docs that should be updated in the same PR (provider, engine, chart template, values schema, label/annotation key, API endpoint, config schema, invariant, Makefile/layout) - New pre-push checklist item: "Documentation impact evaluated per the table above" - New anti-pattern row flagging AGENTS.md drift when an AGENTS.md-described surface changes without updating both synced files in the same PR Refreshes references made stale by NVIDIA#267 (docs reorg): - Repository map entry for docs/ now lists overview.md, architecture.md, api.md explicitly - "Adding a new provider" step 5 points at docs/overview.md instead of README.md for the provider list / scenario table - "When in doubt" pointer to "Choosing a Provider" table updated to docs/overview.md; adds docs/api.md pointer for API/config schema - Simplifies the pre-push checklist (specific provider/engine doc items roll up into the new Documentation Impact Evaluation table) - Prunes README.md out of the registry-wiring anti-pattern (the registry update is the load-bearing concern; doc updates are covered by the new evaluation table) Both files stay byte-identical from line 6 onward. Signed-off-by: Rob Esker <resker@nvidia.com>
c543ba2 to
f055abd
Compare
|
Addressed Greptile's two P1 findings by removing the rows that pointed at content not yet on
Both will be added back via a small follow-up PR once #254 and #259 both merge. Table now has 7 rows, all of which point at content that exists on main today. Force-pushed with the fix. |
Adds back two rows to the Documentation Impact Evaluation table in `AGENTS.md` and `.claude/CLAUDE.md` that were removed from PR NVIDIA#269 to avoid cross-referencing content not yet on `main`: - Chart template row pointing at `docs/engines/k8s.md` "Exposing the Topograph API" section (added to main by PR NVIDIA#259) - Label or annotation key row pointing at `docs/reference/node-labels.md` (added to main by PR NVIDIA#254) Both gating PRs have now merged, so the rows can be restored without broken cross-references. Paired edit preserves the byte-identical invariant between `AGENTS.md` and `.claude/CLAUDE.md` from line 6 onward (verified with `cmp`). Signed-off-by: Rob Esker <resker@nvidia.com>
) * docs(reference): add KEP-4962 upstream-alignment note to node-labels.md Adds a short subsection under `## Labels` covering KEP-4962 ("Standardizing the Representation of Cluster Network Topology"), which is pre-GA and still under upstream review at kubernetes/enhancements#4962 (draft PR #4965). Notes that the KEP's framing allows vendor prefixes like `network.topology.nvidia.com/*` to coexist with the standard `topology.kubernetes.io/` keys rather than replace them, and that Topograph will evaluate aligning or providing both if and when the KEP reaches GA. For now, the `network.topology.nvidia.com/*` keys remain authoritative for Topograph-deployed clusters. This note was deferred from PR #264 because the target file (`docs/reference/node-labels.md`) did not yet exist on `main`; it was introduced by PR #254, which merged 2026-04-19. Signed-off-by: Rob Esker <resker@nvidia.com> * docs(agents): restore two Doc-Impact Evaluation table rows Adds back two rows to the Documentation Impact Evaluation table in `AGENTS.md` and `.claude/CLAUDE.md` that were removed from PR #269 to avoid cross-referencing content not yet on `main`: - Chart template row pointing at `docs/engines/k8s.md` "Exposing the Topograph API" section (added to main by PR #259) - Label or annotation key row pointing at `docs/reference/node-labels.md` (added to main by PR #254) Both gating PRs have now merged, so the rows can be restored without broken cross-references. Paired edit preserves the byte-identical invariant between `AGENTS.md` and `.claude/CLAUDE.md` from line 6 onward (verified with `cmp`). Signed-off-by: Rob Esker <resker@nvidia.com> --------- Signed-off-by: Rob Esker <resker@nvidia.com>
Summary
Builds on the agent-guidance pattern established in #253, adding the explicit Documentation Impact Evaluation guidance that was deferred during that PR's review. Also refreshes references in
AGENTS.mdand.claude/CLAUDE.mdthat were made stale by #267 (docs reorg intodocs/overview.md,docs/architecture.md,docs/api.md).Additions
docs/providers/<name>.md+docs/overview.mdprovider list + "Choosing a Provider" scenario tabledocs/engines/<engine>.mddocs/engines/k8s.md"Exposing the Topograph API" sectionvalues.yamlcomments +NOTES.txt+ any referencing docsdocs/reference/node-labels.mddocs/api.mddocs/api.mdAGENTS.md+.claude/CLAUDE.md(same PR)AGENTS.md+.claude/CLAUDE.md(same PR)Refreshed references (stale after #267 docs reorg)
docs/now explicitly listsoverview.md,architecture.md,api.mdalongside theproviders/,engines/,reference/subdirectoriesdocs/overview.mdinstead ofREADME.mdfor the provider list and "Choosing a Provider" scenario table (these sections moved todocs/overview.mdin docs: organize docs into sections #267)docs/overview.mdfor the scenario table,docs/api.mdfor API endpoints and config schemaInvariants preserved
Both files stay byte-identical from line 6 onward (verified with
cmp <(tail -n +6 .claude/CLAUDE.md) <(tail -n +6 AGENTS.md)).Test plan
main(post-docs: organize docs into sections #267)main