docs(repo): linting with ssgs #2450
Conversation
pamgoodrich
requested review from
billiegoose
and removed request for
billiegoose
docs/guides/2-cli.md
Outdated
| @@ -60,6 +60,8 @@ Here you can build a [custom ruleset](../getting-started/3-rulesets.md), or exte | |||
| - [OpenAPI ruleset](../reference/openapi-rules.md) | |||
| - [AsyncAPI ruleset](../reference/asyncapi-rules.md) | |||
|
|
|||
| > If you use rules created or updated in a hosted [Stoplight API project](https://docs.stoplight.io/docs/platform/branches/pam-716-updated-landing-page/c433d678d027a-create-rules) with the Spectral CLI, you must publish the project from Stoplight before the updates are using for linting. | |||
There was a problem hiding this comment.
"are using for linting" -> " are used for linting" :)
There was a problem hiding this comment.
I don't think we should be including a style guide in Spectral project itself.
This is likely to cause confusion for people.
Thoughts @mnaumanali94?
The docs change is OK though.
P0lip
force-pushed
the
docs/pam-linting-with-ssgs
branch
from
b5d3f8c
to
8f2994f
Compare
P0lip
force-pushed
the
docs/pam-linting-with-ssgs
branch
from
8f2994f
to
586e2b7
Compare
P0lip
force-pushed
the
docs/pam-linting-with-ssgs
branch
from
586e2b7
to
70813ad
Compare
Good point, Jakub. Should I remove both the styleguide.json and .spectral.mjs files? |
I took care of that already :) |
|
🎉 This PR is included in version 6.7.0 🎉 The release is available on: Your semantic-release bot 📦🚀 |
Fixes https://github.com/stoplightio/platform-docs/pull/752.
Added note about hosted style guide updates and Spectral CLI.
Checklist
Does this PR introduce a breaking change?