-
Notifications
You must be signed in to change notification settings - Fork 103
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: mention zed integration (#2637)
* docs: mention zed integration * remove image width
- Loading branch information
Alex Plischke
authored
Feb 14, 2024
1 parent
ff8abed
commit a89f583
Showing
6 changed files
with
31 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
--- | ||
id: zed | ||
title: saucectl with Zed | ||
sidebar_label: Zed | ||
--- | ||
|
||
import useBaseUrl from '@docusaurus/useBaseUrl'; | ||
import Tabs from '@theme/Tabs'; | ||
import TabItem from '@theme/TabItem'; | ||
|
||
Zed can help you edit the `saucectl` configuration files by providing helpful suggestions, autocompletion and docs; all without having to leave the IDE. | ||
|
||
## What You'll Need | ||
|
||
- [Zed](https://zed.dev/) | ||
|
||
## JSON Schema Validation | ||
|
||
Our JSON schema is published to the [JSON Schema Store](https://www.schemastore.org/json/), which is made available to Zed. | ||
|
||
If your `saucectl` config YAML is stored in a `.sauce/` folder, Zed will automatically apply the schema to all YAML files contained in that folder and no further action is required. | ||
|
||
You should now be able to see the docs for various attributes:<br/><img src={useBaseUrl('img/stt/zed-yaml-docs.png')} alt="Zed YAML Attribute Description" /> | ||
|
||
and have autocompletion ready at your fingertips!<br/><img src={useBaseUrl('img/stt/zed-yaml-autocomplete.png')} alt="Zed YAML Attribute Autocompletion" /> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.