chore: package readmes #1695
chore: package readmes #1695
Conversation
|
c/p from slack: I've moved docs from guides to cli, rulestes, functions and formats packages and adjusted some links for it. But guide is broken for now since I don't know how to solve that, and I also wrote very basic list of packages in Contributing.md (some of them I don't know how to describe) |
P0lip
force-pushed
the
develop
branch
4 times, most recently
from
f0b67bd
to
ca55521
Compare
| @@ -21,7 +33,7 @@ Yarn is a package manager for your code, similar to npm. While you can use npm t | |||
| 3. In your terminal, navigate to the directory you cloned Spectral into (check that you are on the `develop` branch). | |||
| 4. Install the dependencies: `yarn` | |||
| 5. Build Spectral: `yarn build` | |||
| 6. Run Spectral from your local installation: `yarn cli lint [openapi_spec_file]` | |||
| 6. Run Spectral from your local installation: `yarn cli cli lint [openapi_spec_file]` | |||
There was a problem hiding this comment.
yea, first cli is a name of yarn workspace and a second one is the name of the command. But it sure does look odd. Maybe we should add cd packages/cli && yarn cli lint [openapi_spec_file] or create a custom cli command in root? @P0lip wdyt?
| @@ -38,7 +38,7 @@ extends: | |||
| - https://raw.githubusercontent.com/openapi-contrib/style-guides/master/apisyouwonthate.yml | |||
| ``` | |||
|
|
|||
| As with any ruleset, you can pass these directly to the [Spectral CLI](./2-cli.md): | |||
| As with any ruleset, you can pass these directly to the [Spectral CLI](../../cli/README.md): | |||
There was a problem hiding this comment.
will this work when the package is published to NPM?
I doubt it'll - perhaps we link to meta.stoplight.io?
|
@mnaumanali94 may we find some volunteers to get this over the finish line? 😆 |
P0lip
force-pushed
the
develop
branch
2 times, most recently
from
cf3ae99
to
761c65a
Compare
P0lip
force-pushed
the
develop
branch
5 times, most recently
from
33deb2b
to
9d6630b
Compare
P0lip
force-pushed
the
develop
branch
2 times, most recently
from
dc9d7f4
to
44c40e2
Compare
P0lip
force-pushed
the
develop
branch
4 times, most recently
from
02ec0d4
to
84faec8
Compare
P0lip
force-pushed
the
develop
branch
3 times, most recently
from
9e92f34
to
6d09915
Compare
P0lip
force-pushed
the
develop
branch
3 times, most recently
from
dc90b7a
to
c22f408
Compare
Addresses stoplightio/platform-internal#6806
Checklist
Does this PR introduce a breaking change?