Skip to content

Commit

Permalink
clarify Zig and ZLS version compatibility in the install tool page
Browse files Browse the repository at this point in the history
  • Loading branch information
Techatrix committed Dec 5, 2024
1 parent 009d02a commit 302a18c
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 4 deletions.
15 changes: 12 additions & 3 deletions content/zls/install.smd
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,16 @@ RWR+9B91GBZ0zOjh6Lr17+zKf5BoSuFvrx2xSeDE57uIYvnKBGmMjOex

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

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

Please header over to the "Editor Configuration" section to set up the editor of your choice.
If you decide to install Zig or ZLS through a different method (e.g. package managers), make sure that you install compatible versions:
- A tagged release of Zig should be used with the same tagged release of ZLS (and vice versa).
- A nightly build of Zig should be used with a nightly build of ZLS (and vice versa).

The install tool above will automatically resolve compatible Zig and ZLS versions.

[]($section.id('next-steps'))
## Next steps

After installing ZLS, please head over to the "Editor Configuration" section to set up the editor(s) of your choice.
3 changes: 2 additions & 1 deletion layouts/zls-install.shtml
Original file line number Diff line number Diff line change
Expand Up @@ -154,6 +154,7 @@
<div id="prebuilt-binary-result" style="display: none;">
<ctx :html="$page.contentSection('install-prebuilt-binary')"></ctx>
</div>
<ctx :html="$page.contentSection('install-editor-extension')"></ctx>
<ctx :html="$page.contentSection('zig-zls-version-compatibility')"></ctx>
<ctx :html="$page.contentSection('next-steps')"></ctx>
<script :html="$site.asset('install.js').bytes()"></script>
</div>

0 comments on commit 302a18c

Please sign in to comment.