docs: adds vale rules and workflow for running in CI #2348
Merged
Conversation
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
lornajane
approved these changes
Jun 30, 2023
AlexVarchuk
approved these changes
Jun 30, 2023
adamaltman
reviewed
Jun 30, 2023
adamaltman
reviewed
Jun 30, 2023
|
We could add the "Redoc" but not "ReDoc" thing to the Vale rules so that it gets automatically caught if this mistake creeps back in. |
adamaltman
reviewed
Jul 7, 2023
| - [Pull Request Guidelines](#pull-request-guidelines) | ||
| - [Development Setup](#development-setup) | ||
| - [Commonly used NPM scripts](#commonly-used-npm-scripts) | ||
| - [Project Structure](#project-structure) | ||
|
|
||
| ## Issue Reporting Guidelines |
There was a problem hiding this comment.
I notice everywhere else in our docs and in our style guide we use sentence-case headings. Should this be adjusted here?
adamaltman
approved these changes
Jul 7, 2023
RomanHotsiy
reviewed
Jul 12, 2023
| - [x-logo example](#x-logo-example) | ||
| - [Tag Object](#tag-object) | ||
| - [x-traitTag](#x-traittag) | ||
| - [How to use with Redoc](#how-to-use-with-redoc-3) |
|
Test, just ignore it. |
ckoegel
pushed a commit
to Bandwidth/redoc
that referenced
this pull request
Nov 1, 2023
* docs: adds vale rules and workflow for running in CI * docs: updates product name from ReDoc to Redoc
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What/Why/How?
In an effort to create consistently coherent documentation across our products we are going to apply the same Vale rules to all of the product doc repos. We have already applied these rules to the redocly CLI docs.
Check yourself