Repository navigation
Update Integrations documentation page with ruff server explanation and setup guides - #12056
snowsignal wants to merge 5 commits into
Conversation
integrations.md with ruff server explanation and setup guidesruff server explanation and setup guides
|
A few questions before I dig into the copy:
|
We should, though I plan to also keep around the deprecated documentation in the Integration page for a little while longer under its own section.
We could probably remove the setup guides, yes. Those have just been copy-pasted. |
|
It seems that our documentation doesn't support more than one top-level heading per page.
Can you try keeping Integrations as the page header and use We should probably also hide the sub-headers in the neovim section from the navigation. |
| The Ruff language server, also known as `ruff server`, is what powers the diagnostic and formatting capabilities of Ruff's VS Code extension and other editors. It is a single, common backend for editor integrations built directly into Ruff, and a direct replacement for `ruff-lsp`, our previous language server. You can read more about `ruff server` in the [`v0.4.5` blog post](https://astral.sh/blog/ruff-v0.4.5). | ||
|
|
There was a problem hiding this comment.
I would remove the mention of ruff-lsp from here. I worry that it is more confusing than helpful for users that just want to set up their IDE.
We could even argue that for most users, the entire Ruff Language Server section isn't relevant if, all they want to do, is set up their VS code.
There was a problem hiding this comment.
I think the added context about the language server would be helpful for users using editors besides VS Code. I'm open to removing the mention of ruff-lsp here, but I think we should still document it in its deprecated state.
There was a problem hiding this comment.
That makes sense. To me, the mentioning in
Other editors may support the legacy
ruff-lspserver; see theruff-lspdocumentation for more.
seems sufficient.
|
I think we should consider documenting all of the supported LSP settings here (it could be similar to what we have in the VS Code README). As-is, I don't think that documentation is available anywhere, or is it? |
|
@charliermarsh We cover the settings that were added/remove in the migration guide, but it isn't a comprehensive list. I agree that having a complete settings guide would make sense for this document. |
|
Should the migration guide also be part of the published documentation? |
|
I'd rather link to it than add it to the documentation itself. |
Co-authored-by: Charlie Marsh <charlie.r.marsh@gmail.com>
|
Closing in favor of #12344 |
No description provided.