docs: update CLI and helm reference for v2.39.2 - #378
Conversation
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
|
Claude finished @github-actions[bot]'s task in 1m 46s —— View job Doc review — CLI reference update for v2.39.2
Verdict: looks good to merge. This is a generated CriticalNone. Improvement
SuggestionNone. What I checked
Two things I could not run in this environment: |
| { | ||
| "snappish1": { | ||
| "snapshot_id": "aws-beta#8227", | ||
| "snapshot_id": "aws-beta#8249", | ||
| "artifacts": [] | ||
| }, | ||
| "snappish2": { | ||
| "snapshot_id": "aws-prod#5309", | ||
| "artifacts": [] | ||
| }, | ||
| "changed": { | ||
| "artifacts": [] | ||
| }, |
There was a problem hiding this comment.
Improvement — The regenerated live example is now a degenerate diff: snappish1.artifacts, snappish2.artifacts, and changed.artifacts are all [], because aws-beta and aws-prod happened to be fully in sync when the docs were generated. Every artifact landed in not-changed.
The whole point of this page is to show what a snapshot diff looks like, so a reader can no longer see the shape of a changed entry (which is the interesting part). Previously the example showed 8 artifacts in snappish1 and 9 in snappish2.
Not a blocker for merging the release update, but worth making the generator resilient — e.g. compare against an older snapshot (aws-prod~5) for this page, or keep the previous output when the fetched diff comes back empty.
| "snappish1": { | ||
| "snapshot_id": "aws-beta#8227", | ||
| "snapshot_id": "aws-beta#8249", | ||
| "artifacts": [] | ||
| }, | ||
| "snappish2": { | ||
| "snapshot_id": "aws-prod#5309", | ||
| "artifacts": [] | ||
| }, | ||
| "changed": { | ||
| "artifacts": [] | ||
| }, |
There was a problem hiding this comment.
Improvement — The regenerated example for kosli diff snapshots now has snappish1.artifacts, snappish2.artifacts and changed.artifacts all empty, so the sample output for a diff command no longer demonstrates a single difference. Everything landed in not-changed.
This is an artifact of generating against a live cyber-dojo environment where aws-beta and aws-prod happened to be in sync at capture time — not a bug in this PR. But it does make the page a weaker reference: a reader can't see what a changed/added/removed artifact entry actually looks like.
Worth considering for the generator (scripts/): capture this example from a snapshot pair that is known to differ, or fall back to a checked-in fixture when the live diff comes back empty.
Automated update of CLI and Helm reference documentation for release
v2.39.2.