Commit Graph

18 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
Andrew Tatomyr
7a496684fa docs: clarify the use of the where section in configurable rules (#1538) 2024-05-20 15:06:34 +03: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
Heather Cloward
8cda648ef6 removed two links to yaml spec as the site is down and it is breaking our preview builds in the marketing site (#1485) 2024-03-15 14:51:22 -04:00
Lorna Jane Mitchell
caa223dce3 docs: fix an incorrectly-formatted table in the custom function docs for configurable rules (#1414) 2024-01-29 14:33:21 +02:00
Andrew Tatomyr
7c7198d72e docs: correct description of multiline patterns usage based on #1353 (#1380) 2024-01-04 12:56:50 +02:00
Lorna Jane Mitchell
574541f12e docs: Add a note about expected newlines in multiline markdown fields (#1372) 2024-01-02 11:17:36 +00:00
Lorna Jane Mitchell
c6831826d4 docs: Add a cookbook mention to the configurable rules page (#1341)
* docs: Add a cookbook mention to the configurable rules page

* chore: Run prettier.
2023-11-28 10:12:25 +00:00
redocly-bot
eadf29f6a8 sync: Synced local 'docs/' with remote 'docs/cli/' 2023-11-03 15:28:27 +00:00
Jeremy Fiel
fcae48e9f4 fix(docs): update example (#1281) 2023-10-19 10:54:11 +02: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
Yaroslav Shuhailo
cfa31330b0 docs: fix typo in 'where' example (#1206) 2023-08-02 18:24:03 +03:00
Lorna Jane Mitchell
3e287a80eb feat: support rule/ as a prefix for configurable rules (#1062)
* feat: support rule/ as a prefix for configurable rules

* chore: Run prettier

* feat: Add a warning about use of the old syntax

* docs: update configurable rules doc to reflect updated rule/ notation

* Update packages/core/src/config/config-resolvers.ts

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

* chore: run prettier

* chore: move deprication warning inside config transformer

---------

Co-authored-by: Andrew Tatomyr <andrew.tatomyr@redocly.com>
2023-05-30 09:57:30 +01:00
redocly-bot
7f8a2e71c0 sync: Synced local 'docs/' with remote 'docs/cli/' 2023-05-10 18:51:45 +00:00
Lorna Jane Mitchell
0455569a39 Docs: top-level refresh and restructure (#1043)
* docs: Start with a more developer and purpose oriented landing page

* docs: Clear installation options, autocomplete is a separate guide

* docs: update links in installation guide

* docs: Move update instructions to be a guide, remove local installation

* docs: Remove git documentation from starter project

* docs: Add a quicker quickstart

* docs: Re-organise and flesh out commands page

* docs: add built-in ruleset docs, add concept, start guide

* docs: Add a guide for configuring linting

* Docs: rename custom rules to assertions

* docs: Sort assertion docs and examples alphabetically

* docs: clearer linting explanations and signposting of rule types

* Apply suggestions from code review

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

* docs: Remove reference to a  config object, after user confusion

* docs: Add docs-building entrypoint article

* docs: Add one-line descriptions alongside rule names

* fix: Correct images for docs overview page

* docs: Link to custom function in custom plugin docs

* fix: Links in rules need updating after this file moved

* docs: Add concept article for openapi file wrangling

* docs: assertions are now called configurable rules

* fix: Broken links and a renamed file

* docs: Titles, links, and restructuring

* Apply suggestions from code review

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

* fix: Redirect for renamed CLI update guide

* Apply suggestions from code review

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

* chore: reduce filesize of images

* docs: Detangle the custom/configurable rules vs assertions confusion

* fix: labels as well as links to configurable rules

* Update docs/guides/configure-rules.md

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

* fix: Better example wording and fix title case

* Update docs/commands/index.md

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

* Update docs/rules/recommended.md

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

* Update docs/quickstart.md

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

* Update docs/rules.md

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

* chore: rename file built-in-rules.md and corresponding links (#1075)

---------

Co-authored-by: Adam Altman <adam@redoc.ly>
2023-05-10 17:40:59 +01:00