Skip to content

Commit 49c4dd8

Browse files
committed
Sync open source content 🐝 (from de16a08f54d18e4a7acaf245dd5ce9890ae222ea)
1 parent 15a2f67 commit 49c4dd8

File tree

3 files changed

+12
-13
lines changed

3 files changed

+12
-13
lines changed

docs/prep-openapi/linting.mdx

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -11,18 +11,21 @@ import Image from "next/image";
1111
# OpenAPI document linting
1212

1313
<Callout title="Tip" type="info">
14-
The &nbsp;
14+
<span>The &nbsp;</span>
1515
<Image
16-
src="/docs/assets/vscode.svg"
16+
src="/assets/vscode.svg"
1717
width="20"
1818
height="20"
1919
style={{ display: "inline-block" }}
2020
alt="Visual Studio Code logo"
2121
/>
22-
&nbsp; [Speakeasy VS Code
23-
extension](https://marketplace.visualstudio.com/items?itemName=Speakeasy.speakeasy-vscode-extension)
24-
provides syntax highlighting and autocompletion for editing the `lint.yaml`
25-
file, as well as linting for OpenAPI documents and other supported file types.
22+
<span>
23+
&nbsp; [Speakeasy VS Code
24+
extension](https://marketplace.visualstudio.com/items?itemName=Speakeasy.speakeasy-vscode-extension)
25+
provides syntax highlighting and autocompletion for editing the `lint.yaml`
26+
file, as well as linting for OpenAPI documents and other supported file
27+
types.
28+
</span>
2629
</Callout>
2730

2831
In addition to running validation, Speakeasy lints OpenAPI documents to ensure stylistic validity. By default, the linter runs using a [recommended set of rules](/docs/linting/linting#speakeasy-recommended), which can be extended with the [available ruleset](/docs/linting/linting#available-rulesets). Custom rules can also be written using the Spectral format.
@@ -60,7 +63,7 @@ sources:
6063
6164
Running `speakeasy run` lints the document as part of the workflow and generates an HTML report accessible from a link in the command output.
6265

63-
3. Use the <Image src="/docs/assets/vscode.svg" width="20" height="20" style={{display: "inline-block"}} alt='Visual Studio Code logo' /> [Speakeasy VS Code extension](https://marketplace.visualstudio.com/items?itemName=Speakeasy.speakeasy-vscode-extension) in the IDE.
66+
3. Use the <Image src="/assets/vscode.svg" width="20" height="20" style={{display: "inline-block"}} alt='Visual Studio Code logo' /> [Speakeasy VS Code extension](https://marketplace.visualstudio.com/items?itemName=Speakeasy.speakeasy-vscode-extension) in the IDE.
6467

6568
By default, these options use the `speakeasy-recommended` ruleset to ensure OpenAPI documents meet the Speakeasy quality bar.
6669

docs/speakeasy-reference/generation/gen-yaml.mdx

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,13 @@
11
import Image from "next/image";
22
import { Callout, Spotlight } from "@/mdx/components";
33

4-
import vsCodeImageUrl from "../../assets/vscode.svg?url";
5-
64
# The gen.yaml file reference
75

86
<Callout title="Tip" type="info">
97

108
For most use cases, the `speakeasy configure` command is the recommended means of interacting with the Speakeasy `gen.yaml` file. The `speakeasy configure` command has subcommands for configuring sources, targets, GitHub workflow setups, and package publications. All new targets created using `speakeasy quickstart` automatically generate workflow files in the `.speakeasy/` folder in the root of the target directory.
119

12-
The <Image src={vsCodeImageUrl} alt="VS Code" width="20" height="20" style={{display: "inline-block"}} /> [Speakeasy VS Code extension](https://marketplace.visualstudio.com/items?itemName=Speakeasy.speakeasy-vscode-extension) provides several useful features for manually editing the `gen.yaml` file, including syntax highlighting, autocompletion, and linting for OpenAPI documents and other supported file types.
10+
The <Image src="/assets/vscode.svg" alt="VS Code" width="20" height="20" style={{display: "inline-block"}} /> [Speakeasy VS Code extension](https://marketplace.visualstudio.com/items?itemName=Speakeasy.speakeasy-vscode-extension) provides several useful features for manually editing the `gen.yaml` file, including syntax highlighting, autocompletion, and linting for OpenAPI documents and other supported file types.
1311

1412
</Callout>
1513

docs/speakeasy-reference/workflow-file.mdx

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,16 +7,14 @@ sidbar_label: Workflow File Reference
77
import Image from "next/image";
88
import { Callout, Spotlight } from "@/mdx/components";
99

10-
import vsCodeImageUrl from "../assets/vscode.svg?url";
11-
1210
# Speakeasy Workflow File
1311

1412
<Callout title="Tip" type="info">
1513
For most use cases we recommend interacting with the Speakeasy workflow file (`workflow.yaml`) through the `speakeasy configure` command.
1614
This command has subcommands to configure sources, targets, github setup and package publishing. All new targets created through `speakeasy quickstart` will automatically have a workflow
1715
file created in the `.speakeasy/` folder in the root of their target directory.
1816

19-
For editing the workflow file manually, <Image src={vsCodeImageUrl} alt="VS Code" width="20" height="20" style={{display: "inline-block"}} /> [Speakeasy's VSCode extension](https://marketplace.visualstudio.com/items?itemName=Speakeasy.speakeasy-vscode-extension) provides syntax highlighting and autocompletion for the workflow file,
17+
For editing the workflow file manually, <Image src="/assets/vscode.svg" alt="VS Code" width="20" height="20" style={{display: "inline-block"}} /> [Speakeasy's VSCode extension](https://marketplace.visualstudio.com/items?itemName=Speakeasy.speakeasy-vscode-extension) provides syntax highlighting and autocompletion for the workflow file,
2018
in addition to linting for OpenAPI documents, and our other supported file types.
2119

2220
</Callout>

0 commit comments

Comments
 (0)