search

astral-sh / ruff

An extremely fast Python linter and code formatter, written in Rust.
https://docs.astral.sh/ruff
MIT License
28.59k stars 925 forks source link

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

Open snowsignal opened 4 days ago

charliermarsh commented 3 days ago

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 commented 3 days ago

@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 commented 3 days ago

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

image

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.

charliermarsh commented 3 days ago

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 commented 3 days ago

@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 commented 3 days ago

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

snowsignal commented 3 days ago

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