Skip to content

docs: align README with the CLI surface - #636

Open
benvinegar wants to merge 1 commit into
mainfrom
claude/readme-surface-cleanup
Open

docs: align README with the CLI surface#636
benvinegar wants to merge 1 commit into
mainfrom
claude/readme-surface-cleanup

Conversation

@benvinegar

Copy link
Copy Markdown
Member

Cleans up the README so it reflects the actual CLI surface and reads top to bottom.

  • Adds missing surface: hunk stash show, hunk diff --staged, and a Git difftool setup section (the features list advertised difftool support but never showed how to configure it).
  • Links the hosted docs at hunk.dev/docs, which the README previously never mentioned.
  • Replaces the grab-bag "Advanced" section with clear "Integrations" (Git pager, difftool, jj, Sapling) and "Configuration" (config, keybindings, extensions, OpenTUI component) sections.
  • Folds the four loose footnote paragraphs under the config example into inline comments and condenses the dense watch-mode paragraph.
  • Keeps the feature-comparison table and screenshots unchanged. Empty changeset (docs-only).

Every command, flag, config key, and integration snippet was fact-checked against src/core/cli.ts, src/core/config.ts, and the loaders (33 claims verified, 0 inaccurate).

🤖 Generated with Claude Code

https://claude.ai/code/session_01KHY9ReVesQXwKdRU47MwJ9


Generated by Claude Code

The README advertised difftool support without setup instructions and
omitted `hunk stash show`, `--staged`, and the hosted docs site. Add the
missing surface, restructure the grab-bag Advanced section into clear
Integrations and Configuration sections, and fold the loose config
footnotes into the example so each section reads top to bottom.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01KHY9ReVesQXwKdRU47MwJ9
@vercel

vercel Bot commented Jul 29, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
hunk-web Ready Ready Preview Jul 29, 2026 12:57am

Request Review

@greptile-apps

greptile-apps Bot commented Jul 29, 2026

Copy link
Copy Markdown
Contributor

Greptile Summary

Updates the README to align documentation with the current CLI surface.

  • Documents staged diffs, stash review, pathspecs, and watch behavior.
  • Adds Git difftool setup and reorganizes integration guidance.
  • Consolidates configuration, extension, keybinding, and OpenTUI documentation.
  • Adds an empty changeset indicating no package release is required.

Confidence Score: 5/5

The documentation-only PR appears safe to merge.

The newly added command examples, watch limitations, integration snippets, configuration claims, extension behavior, and OpenTUI export guidance are consistent with the repository implementation, and no actionable changed-code defect remains.

Important Files Changed

Filename Overview
README.md Reorganizes and expands CLI, integration, and configuration documentation; the newly documented behavior matches the corresponding implementation contracts.
.changeset/readme-surface-cleanup.md Adds a valid empty changeset for this documentation-only update.

Reviews (1): Last reviewed commit: "docs: align README with the CLI surface" | Re-trigger Greptile

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.

2 participants