Skip to content

Make SourceKit-LSP’s documentation more discoverable #1584

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jul 26, 2024
Merged

Make SourceKit-LSP’s documentation more discoverable #1584

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
887345d
Make SourceKit-LSP’s documentation more discoverable
ahoppen Jul 24, 2024
7c99397
Split documentation into user documentation and contributor documenta…
ahoppen Jul 25, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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

Expand Down
0 Documentation/Files To Reindex.md → ...ributor Documentation/Files To Reindex.md
View file
Open in desktop
File renamed without changes.
0 Documentation/LSP Extensions.md → Contributor Documentation/LSP Extensions.md
View file
Open in desktop
File renamed without changes.
0 Documentation/Logging.md → Contributor Documentation/Logging.md
View file
Open in desktop
File renamed without changes.
0 Documentation/Modules.md → Contributor Documentation/Modules.md
View file
Open in desktop
File renamed without changes.
0 Documentation/Overview.md → Contributor Documentation/Overview.md
View file
Open in desktop
File renamed without changes.
10 changes: 10 additions & 0 deletions Contributor Documentation/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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)
0 Documentation/Testing.md → Contributor Documentation/Testing.md
View file
Open in desktop
File renamed without changes.
9 changes: 9 additions & 0 deletions Documentation/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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)
8 changes: 5 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.