Update documentation

InSyncWithFoo · Jul 20, 2024 · cf6becc · cf6becc
1 parent bf2de95
commit cf6becc
Show file tree

Hide file tree

Showing 62 changed files with 490 additions and 854 deletions.
diff --git a/CHANGELOG_CODE.md b/CHANGELOG_CODE.md
@@ -19,15 +19,15 @@ For user-facing changes, see [`CHANGELOG.md`][_-1].
 
 ### Changed
 
-* [The documentation][60-2] is updated. (fcf2c0fb, 91d467ac)
+* [The documentation][60-2] is updated. (fcf2c0fb, 91d467ac, HEAD)
 * [`PyrightBundle`][60-3] and [`PyrightIcon`][60-4] are renamed. (7032faff)
 * Gradle is updated to 8.9. (2397aafd, c5d7c8c8)
 * [Kotlin Serialization Gradle Plugin][60-5] is updated to 1.7.1.
   (330ef0c3, b839a59b)
 * [Kover Gradle Plugin][60-6] is updated to 0.8.2. (eb306695, 87e5660a)
 * [The `lsp4ij` submodule][60-7] is added. (b67210b7)
 * Various files are moved to [the new `cli` submodule][60-8]. (37136d65)
-* Path-hints-related logic is revisited to use `PropertyGraph`. (HEAD)
+* Path-hints-related logic is revisited to use `PropertyGraph`. (bf2de95e)
 
 ### Fixed
 
@@ -37,7 +37,7 @@ For user-facing changes, see [`CHANGELOG.md`][_-1].
 
 
   [60-1]: https://github.com/InSyncWithFoo/pyright-for-pycharm/blob/4ca4b746/src/main/kotlin/com/insyncwithfoo/pyright/actions/CopyFileCommand.kt
-  [60-2]: https://github.com/InSyncWithFoo/pyright-for-pycharm/blob/91d467ac/docs
+  [60-2]: https://github.com/InSyncWithFoo/pyright-for-pycharm/blob/HEAD/docs
   [60-3]: https://github.com/InSyncWithFoo/pyright-for-pycharm/blob/7032faff/src/main/kotlin/com/insyncwithfoo/pyright/Bundle.kt
   [60-4]: https://github.com/InSyncWithFoo/pyright-for-pycharm/blob/7032faff/src/main/kotlin/com/insyncwithfoo/pyright/Icon.kt
   [60-5]: https://github.com/Kotlin/kotlinx.serialization

diff --git a/README.md b/README.md
@@ -6,27 +6,23 @@
 [![Rating](https://img.shields.io/jetbrains/plugin/r/rating/24145)][7]
 [![Downloads](https://img.shields.io/jetbrains/plugin/d/24145)][8]
 
-![](docs/assets/cli-demo-2.png)
+![](./docs/assets/demo.png)
 
 <!-- Plugin description -->
 Pyright integration for PyCharm.
 
 This plugin runs [the Pyright type checker][1] on-the-fly
-as you edit your Python files.
+and reroutes its diagnostics back to the IDE as you code.
 
-It works by saving all your files as-is before running
-the executable provided by you. If you are not OK with that,
-please <em>do not</em> install this plugin.
-
-Note: If you use PyCharm Professional,
-install [the <i>Pyright Language Server</i> plugin][2] instead.
+Warning: Depending on the running mode,
+it might save your files at very fast pace.
 
 
 ## Usage
 
 Go to <b>Settings</b> | <b>Tools</b> |
 <b>Pyright (Global)</b> / <b>Pyright (Project)</b>
-and set the path to your Pyright executable.
+and set the path to your Pyright executable(s).
 
 (Not sure what this means? See [the docs][3] for more information.)
 
@@ -36,7 +32,7 @@ You should see the annotations in a few seconds.
 
   [1]: https://github.com/microsoft/pyright
   [2]: https://github.com/InSyncWithFoo/pyright-langserver-for-pycharm
-  [3]: https://insyncwithfoo.github.io/pyright-for-pycharm/configurations/common/#executable
+  [3]: https://insyncwithfoo.github.io/pyright-for-pycharm/configurations/running-modes/
 <!-- Plugin description end -->
 
 

diff --git a/docs/assets/cli-demo-1.png b/docs/assets/cli-demo-1.png
diff --git a/docs/assets/cli-global-configuration-panel.png b/docs/assets/cli-global-configuration-panel.png
diff --git a/docs/assets/cli-project-configuration-panel.png b/docs/assets/cli-project-configuration-panel.png
diff --git a/...o-others-minimum-severity-level-error.png → ...o-others-minimum-severity-level-error.png b/...o-others-minimum-severity-level-error.png → ...o-others-minimum-severity-level-error.png
diff --git a/...rs-minimum-severity-level-information.png → ...rs-minimum-severity-level-information.png b/...rs-minimum-severity-level-information.png → ...rs-minimum-severity-level-information.png
diff --git a/...others-minimum-severity-level-warning.png → ...others-minimum-severity-level-warning.png b/...others-minimum-severity-level-warning.png → ...others-minimum-severity-level-warning.png
diff --git a/docs/assets/configurations-global-panel.png b/docs/assets/configurations-global-panel.png
diff --git a/docs/assets/configurations-project-panel.png b/docs/assets/configurations-project-panel.png
diff --git a/docs/assets/cli-demo-2.png → docs/assets/demo.png b/docs/assets/cli-demo-2.png → docs/assets/demo.png
diff --git a/...features-demo-auto-suggest-executable.png → ...features-demo-auto-suggest-executable.png b/...features-demo-auto-suggest-executable.png → ...features-demo-auto-suggest-executable.png
diff --git a/docs/assets/icon-outline-10.svg b/docs/assets/icon-outline-10.svg
diff --git a/docs/assets/icon-outline-5-white.svg b/docs/assets/icon-outline-5-white.svg
diff --git a/docs/assets/icon-outline-5.svg b/docs/assets/icon-outline-5.svg
diff --git a/docs/assets/icon-outline-10-white.svg → docs/assets/icon-outline.svg b/docs/assets/icon-outline-10-white.svg → docs/assets/icon-outline.svg
diff --git a/docs/assets/inspection-highlight-severity-levels.png b/docs/assets/inspection-highlight-severity-levels.png
diff --git a/docs/assets/lsp-configurations-demo-auto-import-completions-disabled.png b/docs/assets/lsp-configurations-demo-auto-import-completions-disabled.png
diff --git a/docs/assets/lsp-configurations-demo-autocomplete-parentheses-before.png b/docs/assets/lsp-configurations-demo-autocomplete-parentheses-before.png
diff --git a/docs/assets/lsp-configurations-demo-autocomplete-parentheses-disabled.png b/docs/assets/lsp-configurations-demo-autocomplete-parentheses-disabled.png
diff --git a/docs/assets/lsp-configurations-demo-autocomplete-parentheses-enabled.png b/docs/assets/lsp-configurations-demo-autocomplete-parentheses-enabled.png
diff --git a/docs/assets/lsp-configurations-demo-completion-support-disabled.png b/docs/assets/lsp-configurations-demo-completion-support-disabled.png
diff --git a/docs/assets/lsp-configurations-demo-completion-support-enabled.png b/docs/assets/lsp-configurations-demo-completion-support-enabled.png
diff --git a/docs/assets/lsp-configurations-demo-diagnostics-support-disabled.png b/docs/assets/lsp-configurations-demo-diagnostics-support-disabled.png
diff --git a/docs/assets/lsp-configurations-demo-diagnostics-support-enabled.png b/docs/assets/lsp-configurations-demo-diagnostics-support-enabled.png
diff --git a/docs/assets/lsp-configurations-demo-hover-support-disabled.png b/docs/assets/lsp-configurations-demo-hover-support-disabled.png
diff --git a/docs/assets/lsp-configurations-demo-hover-support-enabled.png b/docs/assets/lsp-configurations-demo-hover-support-enabled.png
diff --git a/docs/assets/lsp-configurations-demo-monkeypatch-auto-import-details-disabled.png b/docs/assets/lsp-configurations-demo-monkeypatch-auto-import-details-disabled.png
diff --git a/docs/assets/lsp-configurations-demo-monkeypatch-auto-import-details-enabled.png b/docs/assets/lsp-configurations-demo-monkeypatch-auto-import-details-enabled.png
diff --git a/docs/assets/lsp-configurations-demo-monkeypatch-trailing-quote-bug-before.png b/docs/assets/lsp-configurations-demo-monkeypatch-trailing-quote-bug-before.png
diff --git a/docs/assets/lsp-configurations-demo-monkeypatch-trailing-quote-bug-disabled.png b/docs/assets/lsp-configurations-demo-monkeypatch-trailing-quote-bug-disabled.png
diff --git a/docs/assets/lsp-configurations-demo-monkeypatch-trailing-quote-bug-enabled.png b/docs/assets/lsp-configurations-demo-monkeypatch-trailing-quote-bug-enabled.png
diff --git a/docs/assets/lsp-configurations-demo-tagged-hints-disabled.png b/docs/assets/lsp-configurations-demo-tagged-hints-disabled.png
diff --git a/docs/assets/lsp-configurations-demo-tagged-hints-enabled.png b/docs/assets/lsp-configurations-demo-tagged-hints-enabled.png
diff --git a/docs/assets/lsp-configurations-demo-tooltips-link-error-codes.png b/docs/assets/lsp-configurations-demo-tooltips-link-error-codes.png
diff --git a/docs/assets/lsp-demo-1.png b/docs/assets/lsp-demo-1.png
diff --git a/docs/assets/lsp-features-demo-auto-suggest-executable.png b/docs/assets/lsp-features-demo-auto-suggest-executable.png
diff --git a/docs/assets/lsp-global-configuration-panel.png b/docs/assets/lsp-global-configuration-panel.png
diff --git a/docs/assets/lsp-project-configuration-panel.png b/docs/assets/lsp-project-configuration-panel.png
diff --git a/docs/assets/lsp-restart-server-button.png b/docs/assets/lsp-restart-server-button.png
diff --git a/docs/assets/lsp4ij-restart-server-button.png b/docs/assets/lsp4ij-restart-server-button.png
diff --git a/docs/assets/lsp4ij-stop-server-button.png b/docs/assets/lsp4ij-stop-server-button.png
diff --git a/docs/configurations/cli.md b/docs/configurations/cli.md
diff --git a/docs/configurations/common.md b/docs/configurations/common.md