docs(repo): linting with ssgs

stoplightio / spectral

A flexible JSON/YAML linter for creating automated style guides, with baked in support for OpenAPI (v3.1, v3.0, and v2.0), Arazzo v1.0, as well as AsyncAPI v2.x.

https://stoplight.io/spectral

Apache License 2.0

2.45k stars 234 forks source link

docs(repo): linting with ssgs #2450

Closed pamgoodrich closed 1 year ago

pamgoodrich commented 1 year ago

Fixes https://github.com/stoplightio/platform-docs/pull/752.

Added note about hosted style guide updates and Spectral CLI.

Checklist

[ ] Tests added / updated
[X] Docs added / updated

Does this PR introduce a breaking change?

[ ] Yes
[X] No

pamgoodrich commented 1 year ago

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.

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.

Good point, Jakub. Should I remove both the styleguide.json and .spectral.mjs files?

P0lip commented 1 year ago

Good point, Jakub. Should I remove both the styleguide.json and .spectral.mjs files?

I took care of that already :)

stoplight-bot commented 1 year ago

:tada: This PR is included in version 6.7.0 :tada:

The release is available on:

Your semantic-release bot :package::rocket: