docs(repo): vale docs review #2352
Closed
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
pamgoodrich
previously approved these changes
Dec 1, 2022
pamgoodrich
previously approved these changes
Dec 13, 2022
| @@ -1,20 +1,20 @@ | |||
| ## Recommended or All | |||
|
|
|||
| Rules by default are considered "recommended" (equivalent to a rule having) `recommended: true` but they can also be marked as not recommended with `recommended: false`. This can help scenarios like rolling out rulesets across API landscapes with a lot of legacy APIs which might have a hard time following every rule immediately. A two-tier system for rules can be helpful here, to avoid requiring several rulesets for this basic use case. | |||
| Rules by default are considered "recommended" (equivalent to a rule having) `recommended: true` but they can also be marked as not recommended with `recommended: false`. This can help scenarios like rolling out rulesets across API landscapes with a lot of legacy APIs which might have a hard time following every rule immediately. A two-tier system for rules can be helpful here, to avoid requiring multiple rulesets for this basic use case. | |||
dotslashderek
force-pushed
the
docs/vale-review
branch
from
ae94983 to
18067c2
Compare
P0lip
force-pushed
the
develop
branch
3 times, most recently
from
cf3ae99 to
761c65a
Compare
P0lip
force-pushed
the
docs/vale-review
branch
from
41a5fc9 to
c516c3a
Compare
2 tasks
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.
Fixes https://github.com/stoplightio/platform-docs/issues/603.
Checklist
Vale review of the Spectral docs using the Stoplight platform-docs Vale style guide.