mirror of
https://github.com/astral-sh/ruff.git
synced 2025-08-04 18:58:04 +00:00
648cca199b
## Summary This PR adds documentation for the Ruff language server. It mainly does the following: 1. Combines various READMEs containing instructions for different editor setup in their respective section on the online docs 2. Provide an enumerated list of server settings. Additionally, it also provides a section for VS Code specific options. 3. Adds a "Features" section which enumerates all the current capabilities of the native server For (2), the settings documentation is done manually but a future improvement (easier after `ruff-lsp` is deprecated) is to move the docs in to Rust struct and generate the documentation from the code itself. And, the VS Code extension specific options can be generated by diffing against the `package.json` in `ruff-vscode` repository. ### Structure 1. Setup: This section contains the configuration for setting up the language server for different editors 2. Features: This section contains a list of capabilities provided by the server along with short GIF to showcase it 3. Settings: This section contains an enumerated list of settings in a similar format to the one for the linter / formatter 4. Migrating from `ruff-lsp` > [!NOTE] > > The settings page is manually written but could possibly be auto-generated via a macro similar to `OptionsMetadata` on the `ClientSettings` struct resolves: #11217 ## Test Plan Generate and open the documentation locally using: 1. `python scripts/generate_mkdocs.py` 2. `mkdocs serve -f mkdocs.insiders.yml` |
||
|---|---|---|
| .. | ||
| benchmarks | ||
| fuzz-parser | ||
| release | ||
| _mdformat_utils.py | ||
| _utils.py | ||
| add_plugin.py | ||
| add_rule.py | ||
| check_docs_formatted.py | ||
| check_ecosystem.py | ||
| Dockerfile.ecosystem | ||
| ecosystem_all_check.py | ||
| ecosystem_all_check.sh | ||
| ecosystem_all_check_entrypoint.sh | ||
| formatter_ecosystem_checks.sh | ||
| generate_known_standard_library.py | ||
| generate_mkdocs.py | ||
| pyproject.toml | ||
| release.sh | ||
| transform_readme.py | ||
| update_ambiguous_characters.py | ||
| update_schemastore.py | ||