Skip to content

Improve readme and clarify examples#18

Merged
JesseHerrick merged 1 commit intomainfrom
readme-improvements
Apr 11, 2026
Merged

Improve readme and clarify examples#18
JesseHerrick merged 1 commit intomainfrom
readme-improvements

Conversation

@JesseHerrick
Copy link
Copy Markdown
Collaborator

@JesseHerrick JesseHerrick commented Apr 11, 2026

MyApp.Repo was a poor example for hover docs. Repo functions do resolve correctly, but ironically there are no docs on the injected functions, thus nothing to show, but this isn't a bug in Dexter. This PR changes this to use MyApp.Accounts as a better example.

Also adds the missing Emacs section to the Table of Contents.


Note

Low Risk
Low risk documentation-only change; no code paths or runtime behavior are modified.

Overview
Updates README.md to improve clarity of documentation examples by switching the sample module/function names from MyApp.Repo to MyApp.Accounts (including delegate/hover/CLI examples) and refreshing the cursor-resolution and rename walkthroughs accordingly.

Also fixes small README hygiene issues (adds missing Emacs link in the table of contents and a trailing comma in the VS Code settings JSON snippet).

Reviewed by Cursor Bugbot for commit 26da58a. Bugbot is set up for automated code reviews on this repo. Configure here.

@JesseHerrick JesseHerrick merged commit 3639bc1 into main Apr 11, 2026
5 checks passed
@JesseHerrick JesseHerrick deleted the readme-improvements branch April 11, 2026 00:16
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