Skip to content

Document git-diff TUI and generated artefact guard#151

Draft
cursor[bot] wants to merge 1 commit into
distro/arch-omarchyfrom
cursor/technical-documentation-updates-13c1
Draft

Document git-diff TUI and generated artefact guard#151
cursor[bot] wants to merge 1 commit into
distro/arch-omarchyfrom
cursor/technical-documentation-updates-13c1

Conversation

@cursor

@cursor cursor Bot commented Jul 18, 2026

Copy link
Copy Markdown
Contributor

Summary

Keeps the docs site aligned with recent dot git-diff and OpenCode plugin changes.

Docs added/updated

  • Added docs/src/content/docs/git/diff.md — dedicated Diff & Repo Watcher page
  • Updated docs/src/content/docs/git/index.mdx — split context and diff into separate cards
  • Updated docs/src/content/docs/bar-integrations.mdx — link bar diff output to the new page
  • Updated docs/src/content/docs/opencode/index.mdx — full generated-artifact table with regeneration commands
  • Updated git sidebar ordering (context, commit, workflows, notifications)

Codepaths covered

  • dot/src/git/tui/DiffView.ts — TUI layout, keyboard shortcuts, index-lock removal
  • dot/src/git/services/DotDiff.ts — changed-repo classification, --no-optional-locks scans, fetch TTL
  • dot/src/git/services/RepoWatcher.ts — polling and lock detection
  • agents/.config/opencode/lib/generated-artifacts.ts — protected artefact list
  • agents/.config/opencode/plugins/generated-artifact-guard.ts — guard behaviour

Key knowledge gaps addressed

  • No user-facing page documented the dot git-diff TUI (keyboard, panes, lock handling) despite recent removal of in-view sync actions and addition of index-lock-safe polling
  • Generated-artifact guard was only mentioned in one bullet; contributors lacked the artefact-to-regeneration-command mapping
  • Bar integrations incorrectly linked diff output to the context integration page

Validation

  • mise run docs:check — build and link validation pass
Open in Web View Automation 

Add a dedicated Diff & Repo Watcher page covering the two-pane layout,
keyboard shortcuts, index-lock behaviour, and upstream fetch caching.
Expand the OpenCode overview with the full generated-artifact table and
fix cross-links from the git index and bar integrations pages.

Co-authored-by: Aidan Timson <aidan@timmo.dev>
@cloudflare-workers-and-pages

Copy link
Copy Markdown

Deploying with  Cloudflare Workers  Cloudflare Workers

The latest updates on your project. Learn more about integrating Git with Workers.

Status Name Latest Commit Preview URL Updated (UTC)
✅ Deployment successful!
View logs
dotfiles-docs 619d120 Commit Preview URL

Branch Preview URL
Jul 18 2026, 06:03 AM

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