Commit Graph

11 Commits

Author SHA1 Message Date
volodymyr-rutskyi
7a0e52f57e feat: add support for a plugin interface common with Realm (#1661) 2024-08-21 14:23:02 +03:00
JLekawa
e2b59a0dfc 1534-review-guide-for-replacing-servers (#1542)
* Removed header numbering, removed "We do" admonition, improved language for consistency.

* Cleaned up markdownlint and vale errors

* Cleaned up markdown

* Ran Prettier

* Apply suggestions from code review

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

* docs: Revert changes to package files

* Update docs/guides/replace-servers-url.md

Co-authored-by: Andrew Tatomyr <andrew.tatomyr@redocly.com>

* Update replace-servers-url.md

Included changes from comments

* Extended intro, added subheadings to "Verify the output", added a summary and resources

* docs: Prettier being fussy

---------

Co-authored-by: Lorna Jane Mitchell <github@lornajane.net>
Co-authored-by: Heather Cloward <heathercloward@gmail.com>
Co-authored-by: Lorna Mitchell <lorna.mitchell@redocly.com>
Co-authored-by: Andrew Tatomyr <andrew.tatomyr@redocly.com>
2024-05-09 10:59:59 +01:00
romana-la
875dfa8d8b docs: replace relative links leading outside of the directory (#1515)
Co-authored-by: Lorna Jane Mitchell <github@lornajane.net>
2024-05-08 11:15:57 +01:00
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
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
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
Adam Altman
9cad7e2e8d docs: rework assertions into custom rules (#917) 2022-11-02 06:58:54 -05:00
redocly-bot
7265665b66 sync: Synced local 'docs/' with remote 'docs/cli/' 2022-10-14 02:49:45 +00:00
Adam Altman
a146a79345 docs: update guide for replace servers url (#907) 2022-10-10 17:29:01 -05:00