Skip to content

Commit 3f43bd2

Browse files
committed
Make SourceKit-LSP’s documentation more discoverable
1 parent 65c1816 commit 3f43bd2

File tree

2 files changed

+27
-3
lines changed

2 files changed

+27
-3
lines changed

Documentation/README.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# Documentation
2+
3+
## User Documentation
4+
5+
The following documentation documents are primarily intended for users of SourceKit-LSP.
6+
7+
- [Configuration File](Configuration%20File.md)
8+
- [Diagnose Bundle](Diagnose%20Bundle.md)
9+
- [Editor Integration](Editor%20Integration.md)
10+
- [Enable Experimental Background Indexing](Enable%20Experimental%20Background%20Indexing.md)
11+
- [Environment Variables](Environment%20Variables.md)
12+
13+
## Developer Documentation
14+
15+
The following documentation documents are primarily intended for developers of SourceKit-LSP.
16+
17+
- [Files To Reindex](Files%20To%20Reindex.md)
18+
- [LSP Extensions](LSP%20Extensions.md)
19+
- [Logging](Logging.md)
20+
- [Modules](Modules.md)
21+
- [Overview](Overview.md)
22+
- [Testing](Testing.md)

README.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,15 @@ SourceKit-LSP is an implementation of the [Language Server Protocol](https://mic
66

77
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.
88

9+
> [!IMPORTANT]
10+
> 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).
11+
12+
To learn more about SourceKit-LSP, refer to the [Documentation](Documentation).
13+
914
## Reporting Issues
1015

1116
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).
1217

13-
> [!IMPORTANT]
14-
> 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.
15-
1618
## Contributing
1719

1820
If you want to contribute code to SourceKit-LSP, see [CONTRIBUTING.md](CONTRIBUTING.md) for more information.

0 commit comments

Comments
 (0)