Skip to content

docs: Commit Graph — 2 regenerated images and 2 verified corrections - #153

Open
Roberto-Vizcarra wants to merge 3 commits into
mainfrom
docs-automation/gitlens-2026-08-19
Open

docs: Commit Graph — 2 regenerated images and 2 verified corrections#153
Roberto-Vizcarra wants to merge 3 commits into
mainfrom
docs-automation/gitlens-2026-08-19

Conversation

@Roberto-Vizcarra

@Roberto-Vizcarra Roberto-Vizcarra commented Aug 19, 2026

Copy link
Copy Markdown
Collaborator

Pilot run of gk-docs-automation, deliberately small so the apply path could be proven on a diff that reads in a minute. Audited range v18.1.0..HEAD (911 commits, 5 releases).

Supersedes #152, which was branched as gitlens-v19.0.1 — a name that implied these changes belong to that release. They do not: a run audits a range and regenerates whatever is stale, which may have last changed several releases ago. Branches are dated now.

Prose corrections — each tied to a change inside the range

The Commit Graph no longer opens in a new tab. 19.0.0 made it lead the GitLens side bar as its main view (#5545). The changelog is specific that only the default location changed, so the correction says so — a reader who moved their graph should not be told it moved back. The width behaviour comes from the same entry, and matters because the rest of the article describes the columnar layout.

Scroll markers behave differently. Same release: clicking a marker now selects and focuses its row rather than scrolling near it, and the marker rail gained a context menu for toggling types in place. The claim that additional types are off by default is checked against package.jsongitlens.graph.scrollMarkers.additionalTypes defaults to [] — not inferred from a screenshot.

Images

Old New Pages
commit-graph.png gl-commit-graph-01-v2@2x.png GL-Commit-Graph.md, gitlens-features.md
search-options.png gl-search-options-01-v2@2x.png GL-Commit-Graph.md, gitlens-features.md

Regenerated from reproducible specs — two consecutive captures were byte-identical before either was accepted. deviceScaleFactor: 2, Playground2026 fixture, Enterprise plan simulated so nothing renders as a feature gate.

No existing image was modified or deleted. New captures get new filenames and references are repointed, so every old file stays live until this merges.

Deliberately not changed

Natural language search is missing from this page, and that is a real gap — but it shipped in 17.3.0 and 17.7.0, outside this range. It is a pre-existing omission rather than something a recent release made inaccurate, so it is reported here rather than folded into a release-range audit.

Same for two current-state discrepancies in the search options that no changelog entry accounts for: a Match All control the page does not list, and match case / match whole word appearing in the opposite order.

Also not included

  • 32 shots deferred — 19 need a connected integration (Launchpad, PR indicators, review state), which cannot be simulated; 13 are animated and multi-frame capture is not built yet.
  • Alt-text backfill is a later phase. 62 GitLens images still carry no alt attribute.
  • 146 GitLens images sit on pages this range did not flag, so they were never inspected.
  • 6 pre-existing dangling image references in this repo, unrelated to this work: SSO-setup.png, gitlens-troubleshooting-bitbucket-pr-on-a-commit.png, gk-dev-account-personalization.png, gk-dev-account-personalization@2x.png, gk-dev-create-account.png, gl-cloud-patch-create.webp.

Review

Four changes total. Worth checking that each image shows what its page claims — reproducibility was proven mechanically, correctness was not.

🤖 Generated with Claude Code


Open with GitKraken

Generated by `gkdocs run GitLens` for `v18.1.0..HEAD`.

Old images are retained — refs are repointed, nothing is deleted or overwritten.

## Images (2)

| Was | Now | Pages | Why |
|---|---|---|---|
| `commit-graph.png` | `gl-commit-graph-01-v2@2x.png` | 2 | pixels differ from the committed image |
| `search-options.png` | `gl-search-options-01-v2@2x.png` | 2 | pixels differ from the committed image |

## Deferred — needs a human

These were not resolved automatically and are **not** included in this PR.

| Subject | Page | Why | What was tried |
|---|---|---|---|
| Rebase | gitlens-docs/gitlens/GL-Branch-Prep-to-ship.md | low-confidence | named in heading, 8 mention(s), 1 change(s), 7 image(s) |
| Rebase | gitlens-docs/gitlens/GL-Agent-Generated-work-end-to-end.md | low-confidence | named in heading, 6 mention(s), 1 change(s), 3 image(s) |
| Commit Graph, Launchpad | gitlens-docs/gitlens/GL-Workflow-Cleanup-prepare-for-review.md | low-confidence | named in bold, 17 mention(s), 127 change(s), 5 image(s); 9 incidental surface(s) trimmed |
| Commit Graph, Launchpad | gitlens-docs/gitlens/GL-Workflow-Understanding-Codebases.md | low-confidence | named in bold, 8 mention(s), 117 change(s), 5 image(s); 3 incidental surface(s) trimmed |
| Cloud Workspaces, GitLens Settings | gitlens-docs/gitlens/GL-Workspaces.md | low-confidence | named in heading, 3 mention(s), 7 change(s), 10 image(s); 3 incidental surface(s) trimmed |
| Pull | gitlens-docs/gitlens/gitlens-troubleshooting.md | low-confidence | named in heading, 4 mention(s), 2 change(s), 2 image(s) |
| Launchpad, Worktrees | gitlens-docs/gitlens/GL-accelerate-pr-reviews.md | low-confidence | named in heading, 13 mention(s), 11 change(s), no images; 2 incidental surface(s) trimmed |
| Commit Graph | gitlens-docs/gitlens/GL-Workflow-Orchestrate-Complex-Git-Operations.md | low-confidence | named in bold, 4 mention(s), 113 change(s), 2 image(s); 5 incidental surface(s) trimmed |
| Inspect | gitlens-docs/gitlens/GL-Visual-File-History.md | low-confidence | named in bold, 1 mention(s), 22 change(s), 2 image(s); 5 incidental surface(s) trimmed |
| Cloud Patches | gitlens-docs/gitlens/GL-Streamline-Collaboration.md | low-confidence | named in heading, 5 mention(s), 1 change(s), no images |
| commit-graph-settings.png | gitlens-docs/gitlens/GL-Commit-Graph.md | no-spec | no spec exists, so this image cannot be regenerated deterministically |
| Commit-Search-Moving-Arrow-Keys.gif | gitlens-docs/gitlens/GL-Commit-Graph.md | no-spec | no spec exists, so this image cannot be regenerated deterministically |
| filter-options-2.png | gitlens-docs/gitlens/GL-Commit-Graph.md | no-spec | no spec exists, so this image cannot be regenerated deterministically |
| gl-column-settings.png | gitlens-docs/gitlens/GL-Commit-Graph.md | no-spec | no spec exists, so this image cannot be regenerated deterministically |
| gl-commit-graph-compact-graph.gif | gitlens-docs/gitlens/GL-Commit-Graph.md | no-spec | no spec exists, so this image cannot be regenerated deterministically |
| gl-context-menu.gif | gitlens-docs/gitlens/GL-Commit-Graph.md | no-spec | no spec exists, so this image cannot be regenerated deterministically |
| gl-hide-refs.gif | gitlens-docs/gitlens/GL-Commit-Graph.md | no-spec | no spec exists, so this image cannot be regenerated deterministically |
| gl-minimap-2.png | gitlens-docs/gitlens/GL-Commit-Graph.md | no-spec | no spec exists, so this image cannot be regenerated deterministically |
| gl-minimap-settings.png | gitlens-docs/gitlens/GL-Commit-Graph.md | no-spec | no spec exists, so this image cannot be regenerated deterministically |
| gl-prefer-commit-graph-location.png | gitlens-docs/gitlens/GL-Commit-Graph.md | no-spec | no spec exists, so this image cannot be regenerated deterministically |
| gl-scroll-markers.png | gitlens-docs/gitlens/GL-Commit-Graph.md | no-spec | no spec exists, so this image cannot be regenerated deterministically |
| graph-info.png | gitlens-docs/gitlens/GL-Commit-Graph.md | no-spec | no spec exists, so this image cannot be regenerated deterministically |
| pull-request-icon.png | gitlens-docs/gitlens/GL-Commit-Graph.md | no-spec | no spec exists, so this image cannot be regenerated deterministically |
| Rich-Commit-Search.png | gitlens-docs/gitlens/GL-Commit-Graph.md | no-spec | no spec exists, so this image cannot be regenerated deterministically |
| show-commit-graph.gif | gitlens-docs/gitlens/GL-Commit-Graph.md | no-spec | no spec exists, so this image cannot be regenerated deterministically |
| GL-Agent-Kanban.png | gitlens-docs/gitlens/home-view.md | other | no alt attribute; needs text generated against the image |
| GL-Agent-approval.png | gitlens-docs/gitlens/GL-Parallel-dev-workflow.md | other | no alt attribute; needs text generated against the image |
| GL-Agent-needs-approval-full-view.png | gitlens-docs/gitlens/GL-Agent-Generated-work-end-to-end.md | other | no alt attribute; needs text generated against the image |
| GL-Agent-working.png | gitlens-docs/gitlens/GL-Parallel-dev-workflow.md | other | no alt attribute; needs text generated against the image |
| GL-Auto-AI-rebase.png | gitlens-docs/gitlens/GL-Branch-Prep-to-ship.md | other | no alt attribute; needs text generated against the image |
| GL-Auto-rebase-resolve.png | gitlens-docs/gitlens/GL-Branch-Prep-to-ship.md | other | no alt attribute; needs text generated against the image |
| GL-Commit-Graph-Full.png | gitlens-docs/gitlens/GL-Branch-Prep-to-ship.md | other | no alt attribute; needs text generated against the image |
| GL-Conflict-detection-auto-rebase.png | gitlens-docs/gitlens/GL-Branch-Prep-to-ship.md | other | no alt attribute; needs text generated against the image |
| GL-Graph-Compare.png | gitlens-docs/gitlens/GL-Branch-Prep-to-ship.md | other | no alt attribute; needs text generated against the image |
| GL-Graph-Compose.png | gitlens-docs/gitlens/GL-Branch-Prep-to-ship.md | other | no alt attribute; needs text generated against the image |

---

Merge manually. WordPress upload runs post-merge and only ever creates new media.
…haviour

Both corrections are tied to changes inside the audited range, v18.1.0..HEAD,
and to a stated default rather than to how the UI happens to look.

"The Commit Graph opens in a new tab" has been wrong since 19.0.0, which made
the graph lead the GitLens side bar as its main view (#5545). The changelog is
specific that only the default location changed, so the correction says so — a
reader who moved their graph should not be told it has moved back. The width
behaviour is the same entry: compact list rows when narrow, columnar table when
widened or moved, which matters because the rest of this article describes the
columnar layout.

Scroll markers changed in the same release. Clicking a marker now selects and
focuses its row rather than scrolling near it, and the marker rail gained a
context menu for toggling types in place. The claim that additional marker
types are off by default is checked against package.json, where
gitlens.graph.scrollMarkers.additionalTypes defaults to [], rather than inferred
from a screenshot.

Deliberately not changed: the search options list. Natural language search is
missing from this page, but it shipped in 17.3.0 and 17.7.0 — outside this
range — so it is a pre-existing gap rather than something this release made
inaccurate, and it is reported separately instead of being folded in here.

Passes the writing standards lint with no errors or warnings.
@Roberto-Vizcarra

Copy link
Copy Markdown
Collaborator Author

@SpaceMerlin33 this is an example PR. do not merge it. I am going to delete the branch and PR, and these changes will be re-run during the initial backfill run of the system.

The heading read "AI Changes Explain `Preview`" while the body beneath it
already listed the commands without the qualifier, so the page contradicted
itself.

Verified against the manifest at both ends of the range rather than inferred:

  v18.0.0     gitlens.ai.explainBranch  "Explain Branch Changes (Preview)..."
              gitlens.ai.explainStash   "Explain Stash Changes (Preview)..."
              gitlens.ai.explainWip     "Explain Working Changes (Preview)..."

  origin/main gitlens.ai.explainBranch  "Explain Branch Changes..."
              gitlens.ai.explainStash   "Explain Stash Changes..."
              gitlens.ai.explainWip     "Explain Working Changes..."

All three dropped it inside v18.0.0..origin/main, so this is an in-range change
making the page inaccurate rather than a pre-existing gap.

Found the way it should have been found: the manifest diff said three command
titles lost "(Preview)", which is the trigger to go and read the page that
documents them. The badge is a markdown code span rather than a quotation of the
command title, so no string matcher was going to catch it — reading was.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants