Commit Graph

53 Commits

Author SHA1 Message Date
Lorna Jane Mitchell
afb5d9425f docs: Update docs tooling and checks (#1330)
* fix: Remove github token with incorrect access

* docs: Improve uninstall CTA in migration guide

* fix: Update checkout action version for vale

* docs: Vale reports errors in any edited file

* docs: Update to make Vale happy

* docs: Markdownlint fixes

* fix: Remove sync actions as this integration is no longer used

* core: Add markdownlint config and github action

Uses rules from https://github.com/Redocly/marketing-site-portal/pull/1142

* chore: Move contributing file to top level

* chore: Add markdown to the file types that we want prettier to operate on

* fix: Make files fit prettier rules, ignore LICENSE since we can't change that

* chore: Combine docs-related workflows into one for simplicity

* docs: Add instructions for running the CLI docs standalone from this repo

* chore: Add changeset, this docs change is quite large

* Update .changeset/bright-steaks-walk.md

Co-authored-by: Ihor Karpiuk <106662428+IgorKarpiuk@users.noreply.github.com>

---------

Co-authored-by: Ihor Karpiuk <106662428+IgorKarpiuk@users.noreply.github.com>
2023-11-20 16:00:32 +00:00
Phil Sturgeon
8af478b038 Lets talk about API Style Guides (#1261)
* Lets talk about API Style Guides

* docs: tweaking API guidelines language and light editing

---------

Co-authored-by: Lorna Mitchell <lorna.mitchell@redocly.com>
2023-11-08 11:25:50 +00:00
Andrew Tatomyr
cfe66a79a9 chore: set minimal required NPM version to 7 (#1267) 2023-09-21 15:46:15 +02:00
Adam Altman
0a73f1f557 refactor: rename to API description for consistency (#1239) 2023-09-18 15:22:26 +02:00
Andrew Tatomyr
0ce9cab59a docs: documentation for telemetry + contributing guide update (#1139)
Co-authored-by: Lorna Mitchell <lorna.mitchell@redocly.com>
Co-authored-by: Ihor Karpiuk <ihor.karpiuk@redocly.com>
2023-06-26 21:26:19 +03:00
Lorna Jane Mitchell
909fb471ca Add Vale for prose linting (#1099)
* feat: Add Vale configuration and rules

* docs: Fix top-level files to match Vale rules

* docs: Vale updates for the commands docs

* docs: apply Vale updates to the decorator docs

* docs: Update guides to match Vale rules

* docs: update rules and other content to meet Vale standards

* docs: add Vale link and information to CONTRIBUTING

* feat: Add GitHub action for Vale

* docs: minor editing to readme.md

* docs: minor editing to the changelog.md file

* docs: minor edits to the join.md file in commands folder

* docs: minor edits to lint.md file in the commands directory

* docs: minor edit to the login.md file in the commands directory

* docs: minor edits to the preview.md file in the commands directory

* docs: minor edits to push.md file in the comands directory

* docs: minor edits to the info-description-override.md file in the decorators directory

* docs: minor edits to the configure-rules.md file in the guides directory

* docs: minor edits to custom-plugin.md file in the resources directory

* docs: minor editing to the no-http-verbs-in-paths.md file in the rules directory

---------

Co-authored-by: Heather Cloward <heathercloward@gmail.com>
2023-06-01 10:10:43 +01:00
Lorna Jane Mitchell
6aabc44e4a Refresh README file (#1059)
* chore: Refresh README file copy

* Update README.md

Co-authored-by: Adam Altman <adam@redoc.ly>

---------

Co-authored-by: Adam Altman <adam@redoc.ly>
2023-05-10 13:26:45 +01:00
Anton Kozachuk
12385e8f3e fix: outdated Docker image name (#949) 2022-11-29 09:21:00 +01:00
Roman Sainchuk
835c5246cf chore: test coverage threshold (#709) 2022-06-03 16:58:30 +02:00
Adam Altman
385216fee6 docs: README update (#678) 2022-05-11 00:33:09 -05:00
Roman Hotsiy
1cacff2044 chore: rename package to @redocly/cli (#672)
Co-authored-by: Andrew Tatomyr <andrew.tatomyr@gmail.com>
Co-authored-by: Ivana Isadora Devcic <skadinna@gmail.com>
2022-05-06 16:12:56 +02:00
Anton Kozachuk
10def1d110 chore: add contributing guide (#564)
Co-authored-by: Ivana Isadora Devcic <33730345+skadinna@users.noreply.github.com>
Co-authored-by: Anton_Kozachuk <anton.kozachuk@cloudmobilizd.com>
2022-02-22 11:18:44 +02:00
Andriy Leliv
6a831f6199 chore: docs for cli local usage (#460)
* chore: docs for cli local usage
* chore: minor changes to phrasing
Co-authored-by: Ivana Isadora Devcic <skadinna@gmail.com>
2021-11-29 10:20:15 +02:00
Roman Hotsiy
67d84c722c chore: update README.md 2021-06-11 11:05:09 +03:00
Adam Altman
43862258b3 chore: fix typo in readme 2021-03-13 10:25:21 -06:00
Adam Altman
7afb0a67e6 docs: fix readme usage of spec vs definition (#264) 2021-03-13 10:22:53 -06:00
Dominik Roos
ceaa205497 feat: add Dockerfile (#247) 2021-02-27 16:00:55 +02:00
romanhotsiy
c5ee28450d chore: fix preview-docs 2020-11-14 14:55:24 +02:00
Mike Ralphson
57411415da docs: credit oas-kit for original speccy/spectral ruleset (#175)
Speccy (was, it is now unmaintained) a thin wrapper around OAS-Kit's `oas-linter`. These rules then went on to inspire the original set in Spectral.
2020-08-11 16:24:40 +03:00
Roman Hotsiy
b4b7173896 chore: update readme 2020-07-09 01:13:02 +03:00
Adam Altman
1004eae058 docs: shorten README and remove other docs (#159) 2020-07-08 11:31:47 -05:00
Roman Hotsiy
27fc643506 chore: rename messages to problems 2020-07-08 00:05:05 +03:00
Roman Hotsiy
3dba1d54c1 docs: add more dev docs 2020-07-04 16:11:52 +03:00
Roman Hotsiy
4d94bf95eb docs: minor docs fixes 2020-07-04 10:54:10 +03:00
Roman Hotsiy
c0c5d34465 chore: rename exceptions file 2020-06-25 16:18:24 +03:00
Roman Hotsiy
3555e66918 chore: rename formats similar to eslint 2020-06-25 14:16:33 +03:00
Roman Hotsiy
0599f0fa46 docs: fix typo 2020-06-25 14:16:33 +03:00
Roman Hotsiy
b096999187 chore: disable operation-tag-defined 2020-06-24 16:56:29 +03:00
Roman Hotsiy
2869cad572 docs: initial docs 2020-06-24 16:55:18 +03:00
Sergey Dubovyk
55b915f402 fix: use master branch for badges 2020-05-16 13:08:33 +03:00
Sergey Dubovyk
2baa58d9ec feat: async API & headers support & registry integration (#107) 2020-03-27 00:45:10 +02:00
Adam Altman
fc6c80680e Preview Docs command docs (#96)
* docs: add preview-docs and fix config file references
2020-01-23 06:06:58 -06:00
Adam Altman
32be72daae docs: Update README for for new config format (#92) 2020-01-16 10:25:18 +02:00
Sergey Dubovyk
a3de8fbd60 feat: support for transforming visitors (#65) 2019-12-17 20:40:33 +02:00
Sergey Dubovyk
3382a2bf5d Update README.md 2019-12-04 17:05:07 +02:00
Adam Altman
9843d80603 docs: Improve the docs about config options 2019-10-29 18:16:29 -05:00
knidarkness
a67f7efdf2 feat: add camelCase checking rule 2019-10-24 00:38:17 +03:00
Sergey Dubovyk
771bd4b676 Update README.md 2019-10-23 11:31:02 +03:00
Adam Altman
a75361fa2e Fix minor README file extension inconsistency
When the default configuration file extension was renamed from yml to yaml
it wasn't renamed through the entire README.
2019-10-22 18:43:19 -05:00
Roman Hotsiy
83181541af docs: update demo gif 2019-10-23 01:33:33 +03:00
Sergey Dubovyk
6a80a8f7d1 Update README.md 2019-10-22 23:16:58 +03:00
Sergey Dubovyk
6c4dfb3d82 added opportunity to ignore rules by given path (#44) 2019-10-22 20:59:24 +03:00
knidarkness
cfaef01267 feat: moved 'bundle' to a separate command 2019-10-19 12:43:31 +03:00
Sergey Dubovyk
f323279150 docs: updated shields.io info 2019-10-18 11:30:16 +03:00
Sergey Dubovyk
2cb46b32ab Added build shield 2019-10-18 11:23:39 +03:00
Sergey Dubovyk
f2666ef2d1 Update README.md 2019-10-17 18:48:03 +03:00
knidarkness
2279b213f6 docs: fix format for config example 2019-10-17 18:12:30 +03:00
knidarkness
cc74df07d0 docs: readme fixes & credits 2019-10-17 18:05:54 +03:00
knidarkness
ea0b33db6f update version for release 2019-10-17 17:43:03 +03:00
Sergey Dubovyk
b5b7b558e2 Update documentation (#37)
* docs: updated docs for release, added license

* docs: remove outdated test files

* update README and rules descriptions

* updated license

* update config file name

* update parameter names

* Grammar fixes, clarifications, and minor restructure of the docs (#36)

* change 'codeframes' param name

* update gif

* update image location

* fix typo
2019-10-17 17:27:27 +03:00