Skip to content

docs(website): add a self-contained Extend section to the docs site - #631

Merged
benvinegar merged 5 commits into
mainfrom
claude/integrations-docs-cleanup-gn24el
Jul 29, 2026
Merged

docs(website): add a self-contained Extend section to the docs site#631
benvinegar merged 5 commits into
mainfrom
claude/integrations-docs-cleanup-gn24el

Conversation

@benvinegar

@benvinegar benvinegar commented Jul 28, 2026

Copy link
Copy Markdown
Member

Scoped to extension docs only — the agent-workflows rewrite, README cleanup, and keybindings page live in #635, #636, and #634 for individual review.

The docs site had no extension documentation, and the first cut of this PR only summarized the surface and linked to docs/extensions.md on GitHub for everything real. The site is the docs, so this now ports the full authoring guide into a new Extend sidebar group of four self-contained pages:

  • Extensions — what an extension is, discovery order and folder extensions, ids, bundled extensions, the trust model, failure isolation, CLI flags and [extensions] / [extension.<id>] config, and the complete collapse-generated example.
  • Extension APIapiVersion, registerTheme, registerFileLanguage, transformChangeset, registerCommand (chords, remapping, the Extensions menu, ctx.selection/navigation/sidebars), dialogs, the lifecycle event table, the hunk.events bus, hunk.config trust caveats, notify, log, and what is not contributable yet.
  • VCS adaptersregisterVcsAdapter, operations, detection order and priorities, watch signatures/plans, readFileSource, extraFiles, moved lines, and HunkExtensionUserError.
  • Custom sidebarsregisterSidebarView, props and actions, the injected keybindings manager, pane ownership, the scrollbox ref contract, and event-driven state via useSyncExternalStore.

Content is ported faithfully from docs/extensions.md (the repo guide is unchanged for now — worth deciding separately whether it should slim down to a pointer once this lands, so the two copies don't drift). Also adds an Extend card to the docs index and cross-links from the configuration page. Empty changeset (docs-only).

bun run website:build (29 pages), bun run website:links, and bun run website:check all pass, including anchor validation for the new cross-page links.

🤖 Generated with Claude Code

https://claude.ai/code/session_01KHY9ReVesQXwKdRU47MwJ9

@vercel

vercel Bot commented Jul 28, 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 1:56am

Request Review

@greptile-apps

greptile-apps Bot commented Jul 28, 2026

Copy link
Copy Markdown
Contributor

Greptile Summary

Reorganizes Hunk’s documentation around clearer user and agent workflows.

  • Condenses the agent workflow guide and designates the generated review skill as the authoritative command reference.
  • Moves keybinding and extension guidance into dedicated website pages and adds them to navigation.
  • Refocuses the README on quick-start workflows, integrations, and links to hosted reference documentation.

Confidence Score: 5/5

The documentation-only reorganization appears safe to merge.

The changed commands, configuration examples, extension behavior, keybinding guidance, links, and website navigation are consistent with the relevant repository contracts, with no concrete changed-code failure identified.

Important Files Changed

Filename Overview
README.md Reorganizes setup, review workflows, integrations, and configuration guidance while linking detailed references.
docs/agent-workflows.md Condenses the human-facing agent workflow and aligns its examples with the generated skill and session CLI.
website/astro.config.mjs Adds the new keybindings and extensions pages to the Configure sidebar.
website/src/content/docs/docs/configure/extensions.md Adds focused documentation for extension discovery, trust, capabilities, and configuration.
website/src/content/docs/docs/configure/keybindings.md Adds focused documentation for keybinding replacement, conflicts, chord grammar, and user-only scope.
website/src/content/docs/docs/configure/configuration.md Cross-links configuration guidance to the new keybindings and extensions pages.

Reviews (1): Last reviewed commit: "docs: streamline agent integration guide..." | Re-trigger Greptile

The site had no page for the experimental extension surface the README
links repo docs for; add a compact guide covering load locations, the
trust model, capabilities, and the [extensions] config keys, wire it
into the Configure sidebar, and cross-link it from the configuration
page.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01KHY9ReVesQXwKdRU47MwJ9
@benvinegar
benvinegar force-pushed the claude/integrations-docs-cleanup-gn24el branch from 093385f to dab9167 Compare July 29, 2026 00:57
@benvinegar benvinegar changed the title Reorganize docs: agent workflows, config, and website structure docs(website): add extensions guide to the docs site Jul 29, 2026
The single extensions page summarized the surface and sent readers to
the repository for everything real. The site is the documentation, so
port the full authoring guide into an Extend section: extensions
(discovery, trust, config, worked example), the extension API, VCS
adapters, and custom sidebars.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01KHY9ReVesQXwKdRU47MwJ9
@benvinegar benvinegar changed the title docs(website): add extensions guide to the docs site docs(website): add a self-contained Extend section to the docs site Jul 29, 2026
The API page is the index of the whole API object, so the two calls
documented on their own pages get in-place summary headings — keeping
them visible in the page's table of contents — that link to the full
contracts.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01KHY9ReVesQXwKdRU47MwJ9
Trust was explained in four places and most rules arrived as long
prose. State each rule once — discovery as a table plus bullets,
trust in its own section only — and cut the editorializing so the
page reads as reference, not narrative.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01KHY9ReVesQXwKdRU47MwJ9
Cut failure-mode narration a developer discovers on their own (invalid
chords, startup-notice details, dialog edge-case exposition) and
compress the long prose runs around commands, selection, and events
into direct statements.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01KHY9ReVesQXwKdRU47MwJ9
@benvinegar
benvinegar enabled auto-merge (squash) July 29, 2026 01:57
@benvinegar
benvinegar merged commit 199939c into main Jul 29, 2026
12 checks passed
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