Commit Graph

24 Commits

Author SHA1 Message Date
dianacheung
4c3d8cf84f docs: update commands documentation (issue 1429) and minor corrections (#1560)
* docs: updated commands documentation per issue 1429 and minor corrections, ran prettier

* docs: updated commands documentation per issue 1429 and included pr 1560 feedback

* docs: minor formatting and copyedits

---------

Co-authored-by: Diana Cheung <18452752+dianacheung@users.noreply.github.com>
Co-authored-by: Lorna Mitchell <lorna.mitchell@redocly.com>
2024-07-05 20:59:59 +01:00
ArkBriar
9456460f77 chore: replace ➡️ with 🔀 to align the words (#1595)
* remove unexpected extra space before Path Items

Signed-off-by: arkbriar <arkbriar@gmail.com>

* Use 🔀 instead of ➡️

Signed-off-by: arkbriar <arkbriar@gmail.com>

* chore: add a changeset

---------

Signed-off-by: arkbriar <arkbriar@gmail.com>
Co-authored-by: Lorna Mitchell <lorna.mitchell@redocly.com>
2024-06-21 10:40:08 +01:00
Lorna Jane Mitchell
fec8220bef docs: Update stats command docs with new markdown output format and a github actions example (#1449)
* docs: Update stats command docs with new markdown output format and a github actions example

* docs: Add screenshot

* Apply suggestions from code review

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

---------

Co-authored-by: Heather Cloward <heathercloward@gmail.com>
2024-02-26 16:51:14 +00:00
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
b325e6f503 chore: rename 'entrypoints' into 'apis' (#802) 2022-08-09 18:07:23 +02: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
5b9cc9d714 sync: Synced local 'docs/' with remote 'docs/cli/' 2022-02-10 17:33:10 +00:00
redocly-bot
a2d848ce03 sync: Synced local 'docs/' with remote 'docs/cli/' 2021-09-30 04:13:25 +00:00
redocly-bot
d79bd84986 sync: Synced local 'docs/' with remote 'docs/cli/' 2021-09-30 04:12:51 +00:00
redocly-bot
37c873b6b2 sync: Synced local 'docs/' with remote 'docs/cli/' 2021-09-30 04:12:48 +00:00
redocly-bot
e021091667 sync: Synced local 'docs/' with remote 'docs/cli/' 2021-09-30 04:12:19 +00:00
redocly-bot
06bdc13041 sync: Synced local 'docs/' with remote 'docs/cli/' 2021-09-30 04:12:09 +00:00
redocly-bot
5c8f9b8bb9 sync: Synced local 'docs/' with remote 'docs/cli/' 2021-09-30 04:11:42 +00:00
Ivana Isadora Devcic
821a1bfcaa fix: minor phrasing changes, removing sentence fragments 2021-09-29 12:45:07 +02:00
Anton Zolotukhin
52e2c8af0c docs: revised stats command 2021-09-24 22:54:18 +03:00
redocly-bot
acc0e31e22 sync: Synced local 'docs/' with remote 'docs/cli/' 2021-07-06 12:49:53 +00:00