diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7740ea1f6..ba5c3e4f8 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,6 +1,6 @@ # Contributing -This document contains notes about development and testing of SourceKit-LSP. +This document contains notes about development and testing of SourceKit-LSP, the [Contributor Documentation](Contributor%20Documentation/) folder has some more detailed documentation. ## Building & Testing diff --git a/Documentation/Files To Reindex.md b/Contributor Documentation/Files To Reindex.md similarity index 100% rename from Documentation/Files To Reindex.md rename to Contributor Documentation/Files To Reindex.md diff --git a/Documentation/LSP Extensions.md b/Contributor Documentation/LSP Extensions.md similarity index 100% rename from Documentation/LSP Extensions.md rename to Contributor Documentation/LSP Extensions.md diff --git a/Documentation/Logging.md b/Contributor Documentation/Logging.md similarity index 100% rename from Documentation/Logging.md rename to Contributor Documentation/Logging.md diff --git a/Documentation/Modules.md b/Contributor Documentation/Modules.md similarity index 100% rename from Documentation/Modules.md rename to Contributor Documentation/Modules.md diff --git a/Documentation/Overview.md b/Contributor Documentation/Overview.md similarity index 100% rename from Documentation/Overview.md rename to Contributor Documentation/Overview.md diff --git a/Contributor Documentation/README.md b/Contributor Documentation/README.md new file mode 100644 index 000000000..eb9cf7e04 --- /dev/null +++ b/Contributor Documentation/README.md @@ -0,0 +1,10 @@ +# Developer Documentation + +The following documentation documents are primarily intended for developers of SourceKit-LSP. + +- [Files To Reindex](Files%20To%20Reindex.md) +- [LSP Extensions](LSP%20Extensions.md) +- [Logging](Logging.md) +- [Modules](Modules.md) +- [Overview](Overview.md) +- [Testing](Testing.md) diff --git a/Documentation/Testing.md b/Contributor Documentation/Testing.md similarity index 100% rename from Documentation/Testing.md rename to Contributor Documentation/Testing.md diff --git a/Documentation/README.md b/Documentation/README.md new file mode 100644 index 000000000..6e61e0a40 --- /dev/null +++ b/Documentation/README.md @@ -0,0 +1,9 @@ +# Documentation + +The following documentation documents are intended for users of SourceKit-LSP. + +- [Configuration File](Configuration%20File.md) +- [Diagnose Bundle](Diagnose%20Bundle.md) +- [Editor Integration](Editor%20Integration.md) +- [Enable Experimental Background Indexing](Enable%20Experimental%20Background%20Indexing.md) +- [Environment Variables](Environment%20Variables.md) diff --git a/README.md b/README.md index 1950e5d96..3883014b8 100644 --- a/README.md +++ b/README.md @@ -6,13 +6,15 @@ SourceKit-LSP is an implementation of the [Language Server Protocol](https://mic https://www.swift.org/tools has a list of popular editors that support LSP and can thus be hooked up to SourceKit-LSP to provide intelligent editor functionality as well as set-up guides. +> [!IMPORTANT] +> SourceKit-LSP does not update its global index in the background or build Swift modules in the background. Thus, a lot of cross-module or global functionality is limited if the project hasn't been built recently. To update the index or rebuild the Swift modules, build your project or enable the experimental background indexing as described in [Enable Experimental Background Indexing](Documentation/Enable%20Experimental%20Background%20Indexing.md). + +To learn more about SourceKit-LSP, refer to the [Documentation](Documentation). + ## Reporting Issues If you should hit any issues while using SourceKit-LSP, we appreciate bug reports on [GitHub Issue](https://github.com/swiftlang/sourcekit-lsp/issues/new/choose). -> [!IMPORTANT] -> SourceKit-LSP does not update its global index in the background or build Swift modules in the background. Thus, a lot of cross-module or global functionality is limited if the project hasn't been built recently. To update the index or rebuild the Swift modules, build the project. - ## Contributing If you want to contribute code to SourceKit-LSP, see [CONTRIBUTING.md](CONTRIBUTING.md) for more information.