Skip to content

Commit 302a18c

Browse files
committed
clarify Zig and ZLS version compatibility in the install tool page
1 parent 009d02a commit 302a18c

File tree

2 files changed

+14
-4
lines changed

2 files changed

+14
-4
lines changed

content/zls/install.smd

+12-3
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,16 @@ RWR+9B91GBZ0zOjh6Lr17+zKf5BoSuFvrx2xSeDE57uIYvnKBGmMjOex
4343

4444
Provided by [zigtools/release-worker](https://github.com/zigtools/release-worker).
4545

46-
[]($section.id('install-editor-extension'))
47-
## Install Editor Extension
46+
[]($section.id('zig-zls-version-compatibility'))
47+
## Zig + ZLS version compatibility
4848

49-
Please header over to the "Editor Configuration" section to set up the editor of your choice.
49+
If you decide to install Zig or ZLS through a different method (e.g. package managers), make sure that you install compatible versions:
50+
- A tagged release of Zig should be used with the same tagged release of ZLS (and vice versa).
51+
- A nightly build of Zig should be used with a nightly build of ZLS (and vice versa).
52+
53+
The install tool above will automatically resolve compatible Zig and ZLS versions.
54+
55+
[]($section.id('next-steps'))
56+
## Next steps
57+
58+
After installing ZLS, please head over to the "Editor Configuration" section to set up the editor(s) of your choice.

layouts/zls-install.shtml

+2-1
Original file line numberDiff line numberDiff line change
@@ -154,6 +154,7 @@
154154
<div id="prebuilt-binary-result" style="display: none;">
155155
<ctx :html="$page.contentSection('install-prebuilt-binary')"></ctx>
156156
</div>
157-
<ctx :html="$page.contentSection('install-editor-extension')"></ctx>
157+
<ctx :html="$page.contentSection('zig-zls-version-compatibility')"></ctx>
158+
<ctx :html="$page.contentSection('next-steps')"></ctx>
158159
<script :html="$site.asset('install.js').bytes()"></script>
159160
</div>

0 commit comments

Comments
 (0)