Update installation instructions #348
Merged
+74
−13
Conversation
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
Updates the installation section to provide more detailed and organized instructions similar to the structure used in Astral's UV documentation. Changes: - Organize installation methods into clear subsections - Add standalone binary installation instructions with platform-specific examples - Document all available pre-built wheel platforms (Linux glibc/musl, macOS, Windows) - Provide instructions for uv, pipx, and pip installation methods - Include links to GitHub Releases for standalone binaries - Fix pip installation examples (removed incorrect --dev flag)
Restructures the installation methods to prioritize system-wide tool installations and adds cargo installation from source. Changes: - Lead with system-wide tool installation (uvx/uv tool install and pipx) - Move pip installation after system-wide tools - Consolidate uv add --dev under pip section - Add cargo installation from source using git - Improve flow and organization of installation options
Corrects misleading phrasing in the system-wide tool installation section. Changes: - Remove uvx (ephemeral execution tool, doesn't install) - Clarify that both uv tool install and pipx create isolated environments - Simplify phrasing to accurately describe what each tool does
Restores uvx as a method to try the language server without installing it, which is perfect for testing it out before committing to an installation. Changes: - Add uvx as first option for trying without installing - Keep uv tool install and pipx for persistent installation - Clarify the difference between trying (uvx) and installing (uv/pipx)
The virtual environment pip installation section was redundant - it's the same command as the general pip install. Users will activate their virtual environment first if they want to install in one. Changes: - Remove duplicate "virtual environment" pip install section - Keep single pip install command - Maintain uv add --dev as alternative
Improves organization and flow of installation instructions based on logical grouping and user needs. Changes: - Move pre-built wheels info into package manager section where it's relevant - Move environment detection note to system-wide tool section where it's most helpful - Add proper PowerShell commands to Windows binary installation for parity with Linux/macOS - Move cargo build from source to end as the most advanced option - Remove redundant pre-built wheels section at the end
Creates a separate "Try it out" section at the top of installation instructions for uvx, making it clear this is the easiest way to test the language server before committing to an installation. Changes: - Create new "Try it out" section as first subsection under Installation - Move uvx command out of system-wide tool installation - Add explanatory text about ephemeral execution - Keep system-wide installation focused on persistent installs (uv/pipx)
Integrates uvx usage into the main installation overview text instead of a separate subsection, and uses the correct command format. Changes: - Remove dedicated "Try it out" subsection - Add uvx command to installation overview paragraph - Use correct command format: uvx --from django-language-server djls serve - Keep installation methods focused on persistent installs
Improves readability by placing the uvx command in a proper code block instead of inline code formatting. Changes: - Move uvx command to its own code block - Add introductory line before code block
Adds a link to the UV documentation about running tools with uvx to help users understand what uvx is and how it works. Changes: - Link uvx to https://docs.astral.sh/uv/guides/tools/#running-tools - Provides context for users unfamiliar with uvx
The platform information was duplicating what's already in the package manager section and isn't needed in the standalone binaries section. Changes: - Remove platform bullet list from standalone binaries section - Keep GitHub Releases link and go straight to installation examples - Platform information is already covered in package manager section
joshuadavidthomas
deleted the
claude/update-lang-server-install-011CUmjRmKC8afCSf6wMqLjg
branch
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
No description provided.