Commit Graph

13 Commits

Author SHA1 Message Date
redocly-bot
1280b08336 sync: Synced local 'docs/' with remote 'docs/cli/' 2023-10-18 14:49:40 +00:00
redocly-bot
9199b2bab7 sync: Synced local 'docs/' with remote 'docs/cli/' 2023-10-09 16:35:49 +00: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
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
Roman Hotsiy
f99cf0cf16 feat: new decorator info-override (#999) 2023-01-25 19:18:11 +08:00
redocly-bot
33502fb2ee sync: Synced local 'docs/' with remote 'docs/cli/' 2023-01-08 17:08:09 +00:00
Antonio
f310b4b8a3 docs: Guide on how to hide openapi extensions (#988)
* docs: add guide to hide custom openapi extensions

* docs: update naming consistency in guide on how to hide openapi extensions

* Rename hide-custom-extensions.md to hide-specification-extensions.md

* docs: change custom extensions to specification extensions

- change file name and links
- change code
- change inline text links
- minor other changes
- fix OpenAPI capitalization

Co-authored-by: Adam Altman <adam@redoc.ly>
2023-01-08 05:55:48 -06:00
Ihor Karpiuk
7cd5c34d54 feat: add media type examples override decorator (#897) 2022-12-23 16:21:06 +02:00
Adam Altman
9cad7e2e8d docs: rework assertions into custom rules (#917) 2022-11-02 06:58:54 -05:00
Adam Altman
a146a79345 docs: update guide for replace servers url (#907) 2022-10-10 17:29:01 -05:00
redocly-bot
e0c57206f3 sync: Synced local 'docs/' with remote 'docs/cli/' 2022-09-13 17:43:59 +00:00
Andrew Tatomyr
504cf32a39 docs: rename "lint" to "styleguide" in Redocly config (#791) 2022-08-11 10:01:27 +02:00
redocly-bot
a73c884b2c sync: Synced local 'docs/' with remote 'docs/cli/' 2022-08-03 12:21:37 +00:00