Skip to content

Readme: Reorganize, add VS Code and performance table notes - #8

Merged
JesseHerrick merged 4 commits into
mainfrom
refine-readme
Apr 9, 2026
Merged

Readme: Reorganize, add VS Code and performance table notes#8
JesseHerrick merged 4 commits into
mainfrom
refine-readme

Conversation

@JesseHerrick

@JesseHerrick JesseHerrick commented Apr 9, 2026

Copy link
Copy Markdown
Member
  • Reorganizes headings so that we focus on Quick Start first, moving the Why and Performance sections below.
  • Adds a note to the VS Code section about potentially needing to set Dexter as your default formatter for Elixir.
  • Clarifies performance table: "Init" was vague and could have implied LSP startup time rather than cold indexing time.

Note

Low Risk
Low risk documentation-only changes; no runtime or API behavior is modified.

Overview
Moves the README’s motivation and benchmarks ("Why build another LSP?" and "Performance") below the setup sections, and updates the table of contents to match.

Clarifies VS Code format-on-save setup by noting you may need to set Dexter as the default Elixir formatter, and renames the performance table’s init row to "Cold first-time index" to avoid ambiguity.

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

@JesseHerrick
JesseHerrick merged commit afc25df into main Apr 9, 2026
4 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.

1 participant