Skip to content

Commit 0fc0e65

Browse files
authored
Merge pull request #6395 from segmentio/co_vale_instructions
adding vale instructions to gh
2 parents b1300b7 + 40ec133 commit 0fc0e65

File tree

1 file changed

+10
-1
lines changed

1 file changed

+10
-1
lines changed

styleguide.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,14 @@
11
# Style guide
2-
When contributing to the docs, please try to follow the rules in this style guide.
2+
When contributing to the docs, follow the rules in this style guide.
3+
4+
## Vale linter
5+
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:
6+
7+
1. Navigate to the `segment-docs` folder, and open it in your terminal.
8+
2. In your terminal, copy the relative link to the .md file you'd like to run through Vale.
9+
3. Type 'vale [relative-link]' into your terminal and press enter.
10+
11+
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.
312

413
## Format for titles and headings
514
Rule | Description |

0 commit comments

Comments
 (0)