docs(repo): linting with ssgs

stoplightio · Apr 6, 2023 · 70813ad · 70813ad
1 parent 60d21c3
commit 70813ad
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -101,6 +101,7 @@ There are also rulesets created by many companies to improve their APIs. You can
 - [Zalando](https://apistylebook.stoplight.io/docs/zalando-restful-api-guidelines) - Based on [Zalando's RESTFUL API Guidelines](https://github.com/zalando/restful-api-guidelines), covers a wide-range of API topics such as versioning standards, property naming standards, the default format for request/response properties, and more.
 
 Check out some additional style guides here:
+
 - [Spectral Rulesets by Stoplight](https://github.com/stoplightio/spectral-rulesets)
 - [API Stylebook by Stoplight](https://apistylebook.stoplight.io)
 

diff --git a/docs/guides/2-cli.md b/docs/guides/2-cli.md
@@ -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 rule updates are used for linting.
+
 ## Error Results
 
 Spectral has a few different error severities: `error`, `warn`, `info`, and `hint`, and they're in order from highest to lowest. By default, all results are shown regardless of severity, but since v5.0, only the presence of errors causes a failure status code of 1. Seeing results and getting a failure code for it are now two different things.