Document Pyrefly usage in Zed

[freyacodes]

Adds instructions for enabling the Pyrefly LSP in Servo.

The change to yaml formatting is to not highlight the JSON comment as an error

[mrobinson]

Thanks, just a few comments:

[mrobinson]

Hrm. If this is a separate extension that isn't the default Python extension, maybe it makes sense to put this in a new block with a small introduction like:

The Pyrefly Zed extension allows for static checking type checking when working with Python code. If you want to you this extension you use it for Servo with the following configuration:

{
  "lsp": {
    "pyrefly": {
      "binary": {
        "path": ".venv/bin/pyrefly",
        "arguments": ["lsp"],
      },
      "settings": {
        "python": {
          "pythonPath": ".venv/bin/python",
        },
        "pyrefly": {
          "project_includes": ["python/**/*.py"],
          "project_excludes": ["**/.[!/.]*", "**/*venv/**"],
          "search_path": ["python"],
          "ignore_errors_in_generated_code": true,
        },
      },
    },
  },
  "languages": {
    "Python": {
      "language_servers": ["pyrefly", "!pyright", "!pylsp"],
    },
  },
}

[freyacodes]

The idea with using yaml highlighting was because YAML is a superset of JSON that supports comments (like the ones in Zed files). Either way, I agree that it makes sense to split it into a different code block.

[freyacodes]

I've decided to rewrite the whole thing. I've added a bit more context and moved it to its own section.

I've also adjusted the actual configuration. The removed settings are instead provided by pyproject.toml.