Commit Graph

27 Commits

Author SHA1 Message Date
Ihor Karpiuk
0c52110c80 chore: set default severity for lint config (#1292) 2023-10-19 16:23:18 +03:00
redocly-bot
9199b2bab7 sync: Synced local 'docs/' with remote 'docs/cli/' 2023-10-09 16:35:49 +00:00
Adam Altman
0a73f1f557 refactor: rename to API description for consistency (#1239) 2023-09-18 15:22:26 +02:00
Lorna Jane Mitchell
daf030b7a8 Custom plugin documentation (#1222)
* Remove extra 'resources' landing page, redirect from main one

* Move custom plugins file to its own directory, add redirect to handle

* docs: split the custom plugins page into one page per feature

* docs: extend decorators explanation and link to it from the custom plugins section

* docs: Fix all the links that were broken when I moved things

* Apply excellent suggestions from code review

Co-authored-by: Heather Cloward <heathercloward@gmail.com>

* docs: Add examples of how to use the custom rule

* docs: Replace the nested visitor example with an object rather than a function

* Update custom-rules.md

minor consistency edits

* Apply suggestions from code review

Co-authored-by: Heather Cloward <heathercloward@gmail.com>

* docs: clearer explanation of skip, and finish a broken sentence

* Update docs/custom-plugins/index.md

Co-authored-by: Heather Cloward <heathercloward@gmail.com>

* Apply suggestions from code review

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

* docs: use object rather than function for visitor

---------

Co-authored-by: Heather Cloward <heathercloward@gmail.com>
Co-authored-by: Adam Altman <adam@redoc.ly>
2023-08-16 14:26:56 +01:00
Lorna Jane Mitchell
9dc78a6d3f docs: Improve CLI usage wording (#1162)
* chore: Tidy up usage options and wording

* docs: Update/refresh command docs pages, add completion page

* chore: run prettier

* fix: keep the previous push command format for backward compatibility

* fix: update test snapshots to match new usage output

* chore: run prettier

* Apply suggestions from code review

Co-authored-by: Heather Cloward <heathercloward@gmail.com>

---------

Co-authored-by: Heather Cloward <heathercloward@gmail.com>
2023-07-12 10:30:05 +01: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
Andrew Tatomyr
6729869869 docs: make greedy arrays false in yargs (#1084) 2023-05-25 16:28:29 +02:00
Lorna Jane Mitchell
3e461d5cc4 Add MLC for link checking (#1097)
* docs: add mlc config and github action to check links

Ignores relative links since we can only check those from the main
website project.

* docs: update redirecting links and configure some ignore patterns
2023-05-25 15:12:36 +01:00
Andrew Tatomyr
b325e6f503 chore: rename 'entrypoints' into 'apis' (#802) 2022-08-09 18:07:23 +02:00
redocly-bot
417c28b6a8 sync: Synced local 'docs/' with remote 'docs/cli/' 2022-07-18 22:16:28 +00:00
redocly-bot
4d8cf1f186 sync: Synced local 'docs/' with remote 'docs/cli/' 2022-05-14 18:42:52 +00:00
redocly-bot
f4db5622b3 sync: Synced local 'docs/' with remote 'docs/cli/' 2022-05-04 19:32:45 +00:00
redocly-bot
d7ed5092e8 sync: Synced local 'docs/' with remote 'docs/cli/' 2022-05-04 18:36:13 +00:00
redocly-bot
297082a16b sync: Synced local 'docs/' with remote 'docs/cli/' 2022-03-23 22:07:26 +00:00
redocly-bot
e152cc45ff sync: Synced local 'docs/' with remote 'docs/cli/' 2022-03-14 10:21:56 +00:00
redocly-bot
5b9cc9d714 sync: Synced local 'docs/' with remote 'docs/cli/' 2022-02-10 17:33:10 +00:00
Glayson Olivieri
487cd91588 feat: add host arg to preview-docs cli command (#479) 2021-12-24 11:25:24 +02:00
Anton Zolotukhin
e5508e3d3c Merge branch 'docs-preview-docs-command' of github.com:bandantonio/openapi-cli into docs-preview-docs-command 2021-10-11 21:20:45 +03:00
Anton Zolotukhin
d8fc07aeea docs: updated preview-docs command according to mentions 2021-10-11 21:18:40 +03:00
Ivana Isadora Devcic
b5d5252dd4 Update docs/commands/preview-docs.md 2021-10-06 12:46:07 +02:00
Ivana Isadora Devcic
784203a392 fix: minor phrasing issues 2021-10-06 12:42:06 +02:00
Anton Zolotukhin
3c41d24c94 docs: fixed minor inconsistencies in preview-docs command 2021-09-28 00:26:58 +03:00
Anton Zolotukhin
b90eda4a4e docs: added information about port for preview-docs command 2021-09-27 23:46:08 +03:00
Anton Zolotukhin
74c76c0688 docs: made content more consistent on the cli preview-docs command page 2021-09-08 00:59:18 +03:00
Anton Zolotukhin
e5eed5b329 docs: fully revised preview-docs command for openapi-cli 2021-09-04 02:49:50 +03:00
redocly-bot
2143028637 sync: Synced local 'docs/' with remote 'docs/cli/' 2021-08-05 01:36:10 +00:00
redocly-bot
acc0e31e22 sync: Synced local 'docs/' with remote 'docs/cli/' 2021-07-06 12:49:53 +00:00