Skip to content

Commit b33da96

Browse files
ahoppenahoppen
committed
Split documentation into user documentation and contributor documentation
1 parent 3f43bd2 commit b33da96

File tree

9 files changed

+12
-15
lines changed

9 files changed

+12
-15
lines changed

‎CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Contributing
22

3-
This document contains notes about development and testing of SourceKit-LSP.
3+
This document contains notes about development and testing of SourceKit-LSP, the [Contributor Documentation](Contributor%20Documentation/) folder has some more detailed documentation.
44

55
## Building & Testing
66

‎Documentation/Files To Reindex.md renamed to ‎Contributor Documentation/Files To Reindex.md

File renamed without changes.

‎Documentation/LSP Extensions.md renamed to ‎Contributor Documentation/LSP Extensions.md

File renamed without changes.

‎Documentation/Logging.md renamed to ‎Contributor Documentation/Logging.md

File renamed without changes.

‎Documentation/Modules.md renamed to ‎Contributor Documentation/Modules.md

File renamed without changes.

‎Documentation/Overview.md renamed to ‎Contributor Documentation/Overview.md

File renamed without changes.

‎Contributor Documentation/README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# Developer Documentation
2+
3+
The following documentation documents are primarily intended for developers of SourceKit-LSP.
4+
5+
- [Files To Reindex](Files%20To%20Reindex.md)
6+
- [LSP Extensions](LSP%20Extensions.md)
7+
- [Logging](Logging.md)
8+
- [Modules](Modules.md)
9+
- [Overview](Overview.md)
10+
- [Testing](Testing.md)

‎Documentation/Testing.md renamed to ‎Contributor Documentation/Testing.md

File renamed without changes.

‎Documentation/README.md

Lines changed: 1 addition & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,9 @@
11
# Documentation
22

3-
## User Documentation
4-
5-
The following documentation documents are primarily intended for users of SourceKit-LSP.
3+
The following documentation documents are intended for users of SourceKit-LSP.
64

75
- [Configuration File](Configuration%20File.md)
86
- [Diagnose Bundle](Diagnose%20Bundle.md)
97
- [Editor Integration](Editor%20Integration.md)
108
- [Enable Experimental Background Indexing](Enable%20Experimental%20Background%20Indexing.md)
119
- [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)

0 commit comments

Comments
 (0)