Skip to content

Commit

Permalink
Apply suggestions from code review
Browse files Browse the repository at this point in the history
Co-authored-by: forstisabella <[email protected]>
  • Loading branch information
cmastr and forstisabella authored Apr 16, 2024
1 parent 319ad1d commit 40ec133
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions styleguide.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
# Style guide
When contributing to the docs, follow the rules in this style guide.

## Vale Linter
To help you follow the style rules in this document, the Segment docs team uses Vale as a linter that will help you find style improvements. To run Vale:
## Vale linter
The Segment docs team uses Vale as a linter, or tool that helps you follow the style rules in our style guide. To run Vale:

1. Open the Segment docs folder from GH Desktop > Current Repository > segment-docs > Open in Terminal
2. In Visual Studio Code, copy the relative link to the .md file from tree in the sidebar.
3. type 'vale [relative-link]' into the terminal, press enter.
1. Navigate to the `segment-docs` folder, and open it in your terminal.
2. In your terminal, copy the relative link to the .md file you'd like to run through Vale.
3. Type 'vale [relative-link]' into your terminal and press enter.

You can also download and install the [Vale extension](https://marketplace.visualstudio.com/items?itemName=chrischinchilla.vale-vscode) to run Vale on demand.
VSCode users can also download and install the [Vale extension](https://marketplace.visualstudio.com/items?itemName=chrischinchilla.vale-vscode){:target="_blank”} to run Vale on demand.

## Format for titles and headings
Rule | Description |
Expand Down

0 comments on commit 40ec133

Please sign in to comment.