Skip to content

docs: GitLens v17.0.0–v19.0.1 audit — prose updates + 31 regenerated images - #157

Draft
Roberto-Vizcarra wants to merge 9 commits into
mainfrom
audit/gitlens-v17-to-v19-backfill
Draft

docs: GitLens v17.0.0–v19.0.1 audit — prose updates + 31 regenerated images#157
Roberto-Vizcarra wants to merge 9 commits into
mainfrom
audit/gitlens-v17-to-v19-backfill

Conversation

@Roberto-Vizcarra

Copy link
Copy Markdown
Collaborator

Generated by gkdocs run gitlens for v17.0.0..v19.0.1.

Summary

Automated documentation audit covering 3,312 commits across 22 releases (v17.0.0 through v19.0.1). This PR includes:

Prose updates

  • 101 prose edits across 12 help center pages
  • New sections for: commit composer, branch recomposition, AI explain commands, natural language commit search, Linear integration, Azure DevOps Server, commit signature verification, Start Review command, submodule support, and more
  • Updated settings documentation for 20+ new/changed settings
  • Corrected feature descriptions and access paths

Regenerated images (31)

  • 8 compose/recompose screenshots with production-quality content from the Playground2026 fixture repo
  • Graph sidebar, commit graph, search, filter, settings, and sign-in/out screenshots
  • All screenshots use realistic TypeScript source files, masked avatars and simulator labels
  • Old images retained — refs repointed, nothing deleted

Deferred (not in this PR)

  • 7 images requiring live integration auth (Launchpad, Cloud Patches, Code Suggest)
  • 15 images without specs yet (need authoring)
  • 3 AI-dependent captures needing manual verification (branch summary, commit message generation)
  • 10 images missing alt text (backfill after image regeneration stabilizes)

Automation repo

Spec fixes, findings, and prose records: gk-docs-automation

@Roberto-Vizcarra Roberto-Vizcarra self-assigned this Aug 27, 2026
Automated capture run for GitLens v17.0.0..v19.0.1 backfill audit.

135 new image assets written (screenshots regenerated from shot specs).
197 image references rewritten across 19 documentation pages.
11 items deferred (10 alt-text backfill, 1 assemble retry needed).

Pages updated:
- gitlens-features.md, gitlens-faq.md, gitlens-settings.md, gitlens-home.md
- GL-Commit-Graph.md, GL-GK-AI.md, GL-Integrations.md, GL-Launchpad.md
- GL-Cloud-Patches.md, GL-Code-Suggest.md, GL-Visual-File-History.md
- GL-Workflow-Cleanup-prepare-for-review.md, GL-Workspaces.md, GL-Worktrees.md
- GL-Agent-Generated-work-end-to-end.md, GL-Branch-Prep-to-ship.md
- GL-Parallel-dev-workflow.md, home-view.md, side-bar.md
- Delete 30 unreferenced older image versions (v2 when v3 exists, etc.)
- Crop ~40 images to remove excessive whitespace/empty editor space
- Add purple highlight annotations to 6 images (stash AI icon, Jira
  integration, delete cloud patch, status bar blame, gutter heatmap,
  pull request icon)

12 images flagged for recapture (wrong content or static PNG with
.gif extension): gl-agent-kanban, gl-ai-branch-summary,
gl-ai-generate-changelog, gl-ai-generated-commit-message (x2),
gl-auto-rebase-resolve, gl-code-suggest, gl-commits-view-merge,
gl-commits-view-rebase, gl-convert-workspace-to-cloud,
gl-create-vs-workspace-from-gl, gl-create-workspace
run --apply rewrote refs to new versioned filenames (e.g.
gl-agent-kanban-01-v2@2x.png) but the captures were incorrect and
never uploaded to WordPress. Reverting to the original filenames that
still exist on the WordPress server.

These 12 images are deferred as manualCaptureOnly in gk-docs-automation
and will be recaptured in a follow-up PR.
Round 2 visual verification found 51 incorrect captures (39% failure rate).
48 refs reverted to originals still on WordPress. 3 new-section images
(graph-sidebar, graph-details-panel, rich-commit-search) have no original
to revert to and will be fixed in recapture.

Failure categories: Get Started panel visible (~6), wrong view/panel (~15),
generic commit graph with no feature (~9), empty panels (~6), wrong state (~15).
Recaptured all 33 previously failed specs plus 2 newly automated
specs (gl-file-history-view-merge-conflict-01, gl-revision-navigation-01).

Fixes: onboarding dismiss in all spec setups, subscription simulation
removal, correct command names for PR creation and Settings webview,
xdotoolClick for hover dismissal in Tags view.
Replaces the 13 images the 2026-09-04 visual audit flagged as showing the
wrong content, and deletes one orphaned regeneration. Each replacement was
captured from a corrected spec and visually verified. Per-image findings and
root causes are in gk-docs-automation/docs/visual-audit-findings.md.

- gl-commits-view-01-v2@2x: hover tooltip overlay removed
- gl-rich-commit-search-02-v2@2x: full graph webview with highlighted results
- gl-access-composer-1-17-4-01-v3@2x: labeled Compose entry point
- gl-worktrees-view-01-v2@2x: current worktree expanded (upstream, compare, commits)
- gl-column-settings: current v19 column settings menu (was a plain graph)
- gl-connect-to-remote-ghe-01-v2@2x: unlinked GHE remote with the Connect plug
- gl-graph-details-panel-01-v2: populated details panel for the selected commit
- gl-graph-sidebar-01-v2: expanded sidebar branches tree
- gl-commit-graph-compact-graph-01-v2@2x: real compact toggle (avatars -> dots)
- gl-hide-refs-01-v2@2x: scope popover hiding remote-only refs
- gl-agent-working-01-v2@2x: Agents section with a live working session
- gl-ai-generated-commit-message-01-v2: real GitKraken AI commit message
- gl-ai-stash-01-v2@2x: AI-generated stash message
@Roberto-Vizcarra

Copy link
Copy Markdown
Collaborator Author

This is a thick one boys. the prose edits are likely all fine, but the images are hit and miss. I haven't gone through all of them, and I'm going to have it do another review/polishing pass for all of them to validate they are all showing the right thing, and if they need annotations, etc. This is an example of what one of the automated HC updates would be like (just much bigger than the subsequent ones).

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.

1 participant