docs: Overhaul Julia selection and server launch documentation - #76
Open
aviatesk wants to merge 1 commit into
Open
docs: Overhaul Julia selection and server launch documentation#76aviatesk wants to merge 1 commit into
aviatesk wants to merge 1 commit into
Conversation
The README predated the direct `julia -m JETLS` launch and left key behavior undocumented: `binary.arguments` examples used a `--` separator that was never explained, juliaup users had no documented way to select a Julia channel, and the runtime override and custom command examples were duplicated rather than organized by use case. This change restructures the Julia selection and launch sections after the jetls-vscode README. The "Julia executable" and "Julia for JETLS" sections become use-case bullet lists covering juliaup channel selection (via direnv `JULIAUP_CHANNEL` and via `binary.env.JULIAUP_CHANNEL`) and direct executable selection (direnv `PATH_add` and `JULIA_APPS_JULIA_CMD`), each stating the launcher-resolution condition, the JETLS-only scope of `binary.env`, and the Windows executable caveat. The launch section now shows the exact managed launch command and explains the `--` argument protocol, and the custom command section splits the user-managed binary and local checkout development cases into separate bullets. The change also applies consistency and formatting cleanups across the file: version phrasing alignment, jsonc trailing-comma style, line-length rewraps, a reflow of the legacy REPL and plot side pane sections, and typo and grammar fixes. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
aviatesk
force-pushed
the
avi/update-README
branch
from
August 29, 2026 07:36
23fd449 to
40b618c
Compare
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.
The README predated the direct
julia -m JETLSlaunch and left key behavior undocumented:binary.argumentsexamples used a--separator that was never explained, juliaup users had no documented way to select a Julia channel, and the runtime override and custom command examples were duplicated rather than organized by use case.This change restructures the Julia selection and launch sections after the jetls-vscode README. The "Julia executable" and "Julia for JETLS" sections become use-case bullet lists covering juliaup channel selection (via direnv
JULIAUP_CHANNELand viabinary.env.JULIAUP_CHANNEL) and direct executable selection (direnvPATH_addandJULIA_APPS_JULIA_CMD), each stating the launcher-resolution condition, the JETLS-only scope ofbinary.env, and the Windows executable caveat. The launch section now shows the exact managed launch command and explains the--argument protocol, and the custom command section splits the user-managed binary and local checkout development cases into separate bullets.The change also applies consistency and formatting cleanups across the file: version phrasing alignment, jsonc trailing-comma style, line-length rewraps, a reflow of the legacy REPL and plot side pane sections, and typo and grammar fixes.