docs(repo): grammar review #2256
Conversation
heitortsergent
requested review from
chohmann and
pamgoodrich
and removed request for
chohmann
heitortsergent
changed the title
| @@ -62,21 +62,21 @@ Here you can build a [custom ruleset](../getting-started/3-rulesets.md), or exte | |||
|
|
|||
| ## Error Results | |||
|
|
|||
| Spectral has a few different error severities: `error`, `warn`, `info` and `hint`, and they are in "order" from highest to lowest. By default, all results will be shown regardless of severity, but since v5.0, only the presence of errors will cause a failure status code of 1. Seeing results and getting a failure code for it are now two different things. | |||
| Spectral has a few different error severities: `error`, `warn`, `info`, and `hint`, and they are in "order" from highest to lowest. By default, all results will be shown regardless of severity, but since v5.0, only the presence of errors will cause a failure status code of 1. Seeing results and getting a failure code for it are now two different things. | |||
There was a problem hiding this comment.
Do you think we need to keep the reference to v5.0?
There was a problem hiding this comment.
I'm not sure... I just looked at npm download numbers for v5 and the numbers are really small (here and here), but I'm not sure if that's the only place to check.
@philsturgeon or @P0lip what do you think?
|
|
||
| ## Code Transpilation | ||
|
|
||
| We encourage you to not transpile the code to ES5 if you can help it. Spectral does not support older environments than ES2019, so there is no need to bloat the bundle with useless transformations and polyfills. Ship untransformed async/await, do not include unneeded shims, it's all good. | ||
|
|
||
| Prior to 6.x, Spectral hadn't supported ES Modules, yet as of recently using ES Modules is the recommended way to do things. | ||
| Before 6.x, Spectral hadn't supported ES Modules, yet as of recently using ES Modules is the recommended way to do things. |
There was a problem hiding this comment.
I have no idea what version we are on now. Not sure we need this reference.
I see we have migration topics. I'd move any of this version-specific stuff to those topics. In general, the "current" doc should discuss things as they are now.
There was a problem hiding this comment.
We're on v6 now, I think depending on the answer to the other comment we can update this to "ES Modules is the recommended way to do things.", or maybe remove it?
|
@philsturgeon @P0lip @mnaumanali94 would any of you like to take a look at this? This ballooned into a big PR (sorry about that 😵💫), but most of the changes are grammar fixes. |
Checklist
Additional context
I took a pass at all the docs using Grammarly to try and fix any grammar mistakes, and also made some small edits where I thought things could be improved.
I was hoping to run the docs through Vale as well using the writing style guide we're using for the Stoplight docs, but I think that would make this PR too big, so I'm going to do this in a separate PR after I work on #2233.