Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update Integrations documentation page with ruff server explanation and setup guides #12056

Closed
wants to merge 5 commits into from

Conversation

snowsignal
Copy link
Contributor

No description provided.

@snowsignal snowsignal added documentation Improvements or additions to documentation server Related to the LSP server labels Jun 26, 2024
@snowsignal snowsignal added this to the Ruff Server: Stable milestone Jun 26, 2024
@snowsignal snowsignal changed the title Update integrations.md with ruff server explanation and setup guides Update Integrations documentation page with ruff server explanation and setup guides Jun 26, 2024
@charliermarsh
Copy link
Member

A few questions before I dig into the copy:

  1. As mentioned in Discord, should we move any ruff-lsp documentation that doesn't already exist in the ruff-lsp README to that README, so we're not losing anything useful?

  2. Should this be replacing the setup guides and documentation that you have in the ruff-server crate? If not, why not? What's the difference?

@snowsignal
Copy link
Contributor Author

@charliermarsh

  1. As mentioned in Discord, should we move any ruff-lsp documentation that doesn't already exist in the ruff-lsp README to that README, so we're not losing anything useful?

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.

  1. Should this be replacing the setup guides and documentation that you have in the ruff-server crate? If not, why not? What's the difference?

We could probably remove the setup guides, yes. Those have just been copy-pasted.

@MichaReiser
Copy link
Member

MichaReiser commented Jun 28, 2024

It seems that our documentation doesn't support more than one top-level heading per page.

image

  • The navigation entry is Integrations but the page title is Editor Integrations
  • Editor Integrations doesn't show up in the navigation
  • The entire Other integrations sub menu is missing

Can you try keeping Integrations as the page header and use ## for Editor integrations and Other integrations (and reduce the heading of all other sub-headings).

We should probably also hide the sub-headers in the neovim section from the navigation.

Comment on lines 5 to 6
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).

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That makes sense. To me, the mentioning in

Other editors may support the legacy ruff-lsp server; see the ruff-lsp documentation for more.

seems sufficient.

docs/integrations.md Outdated Show resolved Hide resolved
docs/integrations.md Outdated Show resolved Hide resolved
docs/integrations.md Outdated Show resolved Hide resolved
docs/integrations.md Outdated Show resolved Hide resolved
docs/integrations.md Outdated Show resolved Hide resolved
docs/integrations.md Outdated Show resolved Hide resolved
docs/integrations.md Outdated Show resolved Hide resolved
docs/integrations.md Outdated Show resolved Hide resolved
@charliermarsh
Copy link
Member

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?

@snowsignal
Copy link
Contributor Author

snowsignal commented Jun 28, 2024

@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.

@charliermarsh
Copy link
Member

Should the migration guide also be part of the published documentation?

@snowsignal
Copy link
Contributor Author

I'd rather link to it than add it to the documentation itself.

@dhruvmanila
Copy link
Member

Closing in favor of #12344

@dhruvmanila dhruvmanila removed this from the Ruff Server: Stable milestone Jul 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation server Related to the LSP server
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants