docs(extensions): add example gallery - #688
Open
benvinegar wants to merge 1 commit into
Open
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Contributor
Greptile SummaryThis documentation-only PR adds a canonical gallery for four opt-in extension examples and cross-links it from the main authoring and website guides.
Confidence Score: 4/5The PR appears safe to merge after addressing two non-blocking documentation accuracy issues in the new gallery. The extension inventories and repository paths are otherwise consistent, but the gallery uses a noncanonical website domain and promises an exact runnable command that one linked example does not currently provide. Files Needing Attention: examples/extensions/README.md Important Files Changed
Prompt To Fix All With AI### Issue 1
examples/extensions/README.md:25
**Use the canonical website origin**
These three links use `hunkdiff.dev`, while the website configuration and deployment documentation consistently use `hunk.dev`; readers are therefore sent through an origin that is not maintained as part of the documented website deployment.
```suggestion
Start with the [extension authoring guide](../../docs/extensions.md), then use the focused website guides for [custom sidebars](https://hunk.dev/docs/extend/custom-sidebars/), [file previews](https://hunk.dev/docs/extend/file-previews/), and [VCS adapters](https://hunk.dev/docs/extend/vcs-adapters/).
```
### Issue 2
examples/extensions/README.md:12
**Exact-command promise is inaccurate**
The gallery promises an exact command in every linked README, but the rendered-Markdown command references `before.md` and `after.md`, which are absent from the checkout. Following that example therefore does not provide the advertised runnable scenario; point it at included fixtures or identify the arguments as user-supplied files.
---
For each issue above, determine whether it is valid and should be fixed. If so, fix it directly.Reviews (1): Last reviewed commit: "docs(extensions): add example gallery" | Re-trigger Greptile |
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
|
|
||
| ## Learn the API | ||
|
|
||
| Start with the [extension authoring guide](../../docs/extensions.md), then use the focused website guides for [custom sidebars](https://hunkdiff.dev/docs/extend/custom-sidebars/), [file previews](https://hunkdiff.dev/docs/extend/file-previews/), and [VCS adapters](https://hunkdiff.dev/docs/extend/vcs-adapters/). |
Contributor
There was a problem hiding this comment.
These three links use hunkdiff.dev, while the website configuration and deployment documentation consistently use hunk.dev; readers are therefore sent through an origin that is not maintained as part of the documented website deployment.
Suggested change
| Start with the [extension authoring guide](../../docs/extensions.md), then use the focused website guides for [custom sidebars](https://hunkdiff.dev/docs/extend/custom-sidebars/), [file previews](https://hunkdiff.dev/docs/extend/file-previews/), and [VCS adapters](https://hunkdiff.dev/docs/extend/vcs-adapters/). | |
| Start with the [extension authoring guide](../../docs/extensions.md), then use the focused website guides for [custom sidebars](https://hunk.dev/docs/extend/custom-sidebars/), [file previews](https://hunk.dev/docs/extend/file-previews/), and [VCS adapters](https://hunk.dev/docs/extend/vcs-adapters/). |
Prompt To Fix With AI
This is a comment left during a code review.
Path: examples/extensions/README.md
Line: 25
Comment:
**Use the canonical website origin**
These three links use `hunkdiff.dev`, while the website configuration and deployment documentation consistently use `hunk.dev`; readers are therefore sent through an origin that is not maintained as part of the documented website deployment.
```suggestion
Start with the [extension authoring guide](../../docs/extensions.md), then use the focused website guides for [custom sidebars](https://hunk.dev/docs/extend/custom-sidebars/), [file previews](https://hunk.dev/docs/extend/file-previews/), and [VCS adapters](https://hunk.dev/docs/extend/vcs-adapters/).
```
---
For each issue above, determine whether it is valid and should be fixed. If so, fix it directly.Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!
| | [`jsx-file-view/`](jsx-file-view/) | The smallest fixed-height React/OpenTUI file-view proof of concept, including hooks, semantic theme props, and row fallback | Custom JSX rows | | ||
| | [`jsx-file-view-gallery/`](jsx-file-view-gallery/) | TypeScript change-atlas cards, CSS color swatches, dependency-version deltas, and a mixed raw/custom five-file review | Realistic file-view layouts and fallback behavior | | ||
|
|
||
| Each folder has its own README with an exact command and notes on the API contract it exercises. Run an example directly from this checkout with `--extension` while developing. To install one, copy its complete folder into `~/.config/hunk/extensions/` and install any dependency its `package.json` declares. |
Contributor
There was a problem hiding this comment.
The gallery promises an exact command in every linked README, but the rendered-Markdown command references before.md and after.md, which are absent from the checkout. Following that example therefore does not provide the advertised runnable scenario; point it at included fixtures or identify the arguments as user-supplied files.
Knowledge Base Used: Extension System: API, Loading, and Host Integration
Prompt To Fix With AI
This is a comment left during a code review.
Path: examples/extensions/README.md
Line: 12
Comment:
**Exact-command promise is inaccurate**
The gallery promises an exact command in every linked README, but the rendered-Markdown command references `before.md` and `after.md`, which are absent from the checkout. Following that example therefore does not provide the advertised runnable scenario; point it at included fixtures or identify the arguments as user-supplied files.
**Knowledge Base Used:** [Extension System: API, Loading, and Host Integration](https://app.greptile.com/modem/-/custom-context/knowledge-base/modem-dev/hunk/-/docs/extension-system.md)
---
For each issue above, determine whether it is valid and should be fixed. If so, fix it directly.
10 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
examples/extensions/README.mdgallery covering all four opt-in extension packages and their runnable scenariosWhy
The examples were already mostly centralized under
examples/extensions/, but their indexes disagreed: the examples README listed four packages while the root README and authoring guide exposed only two, and the website split the others across topic pages. This gives extension authors one canonical inventory without moving or duplicating the implementations.Validation
bun run format:checkbun run website:checkbun run website:buildbun run website:linksbun run check:pack— 25 extension guide examples typecheck for NodeNext and bundler consumersThis PR description was generated by Pi using OpenAI GPT-5.6-sol