Commit Graph

46 Commits

Author SHA1 Message Date
Andrew Tatomyr
e1ddf8e12e feat: add output as a per-API configuration option (#1708) 2024-09-06 13:56:02 +03:00
Taylor Krusen
dbbbad889c Updating json-schema tag (#1549) 2024-05-10 07:57:18 -07: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
Dmytro Anansky
9343b35cdd feat: drop linting option from bundle command (#1503) 2024-04-02 12:12:16 +03:00
Lorna Jane Mitchell
17b73c1723 docs: add cli config reference (#1483)
* docs: Add resolve config reference

* docs: Start API reference, needs child config entries

* docs: Add sidebar entries for config reference pages

* docs: Add rules and decorators config pages

* docs: Fix links and format

* docs: Fix links and formatting

* docs: Add extends and plugins config reference pages

* docs: Add a basic preprocessor page

* docs: Update from review feedback

* Apply suggestions from code review

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

* docs: Reformat required labels

* Apply suggestions from code review

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

* docs: Fix misspelling

---------

Co-authored-by: Heather Cloward <heathercloward@gmail.com>
2024-03-26 09:49:17 +00:00
Andrew Tatomyr
9930c3c339 docs: explain using refs in a config file (#1364)
Co-authored-by: Heather Cloward <heathercloward@gmail.com>
2023-12-21 18:41:54 +02:00
Lorna Jane Mitchell
afb5d9425f docs: Update docs tooling and checks (#1330)
* fix: Remove github token with incorrect access

* docs: Improve uninstall CTA in migration guide

* fix: Update checkout action version for vale

* docs: Vale reports errors in any edited file

* docs: Update to make Vale happy

* docs: Markdownlint fixes

* fix: Remove sync actions as this integration is no longer used

* core: Add markdownlint config and github action

Uses rules from https://github.com/Redocly/marketing-site-portal/pull/1142

* chore: Move contributing file to top level

* chore: Add markdown to the file types that we want prettier to operate on

* fix: Make files fit prettier rules, ignore LICENSE since we can't change that

* chore: Combine docs-related workflows into one for simplicity

* docs: Add instructions for running the CLI docs standalone from this repo

* chore: Add changeset, this docs change is quite large

* Update .changeset/bright-steaks-walk.md

Co-authored-by: Ihor Karpiuk <106662428+IgorKarpiuk@users.noreply.github.com>

---------

Co-authored-by: Ihor Karpiuk <106662428+IgorKarpiuk@users.noreply.github.com>
2023-11-20 16:00:32 +00:00
Andrew Tatomyr
4620f79f29 feat: add built-in recommeded-strict ruleset (#1311) 2023-10-26 15:07:19 +03:00
redocly-bot
1280b08336 sync: Synced local 'docs/' with remote 'docs/cli/' 2023-10-18 14:49:40 +00:00
redocly-bot
85a5c6b281 sync: Synced local 'docs/' with remote 'docs/cli/' 2023-10-09 19:12:22 +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
redocly-bot
068db392ae sync: Synced local 'docs/' with remote 'docs/cli/' 2023-08-18 13:10:39 +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
redocly-bot
f7a6a036ec sync: Synced local 'docs/' with remote 'docs/cli/' 2023-07-27 12:39:02 +00:00
redocly-bot
0976fbabab sync: Synced local 'docs/' with remote 'docs/cli/' 2023-07-25 18:37:28 +00:00
Andrew Tatomyr
fb47a20b8c chore: use prettier more (#1109) 2023-05-31 12:01:20 +02:00
redocly-bot
4d8811cdfc sync: Synced local 'docs/' with remote 'docs/cli/' 2023-02-18 14:09:51 +00:00
Adam Altman
a2213bb5db docs: rename features.openapi and features.mockServer in config (#983) 2023-01-25 12:05:03 +02:00
Andrew Tatomyr
0fe813e9be docs: do not add the default recommended fallback when there is a config file (#939) 2022-11-21 17:01:39 +01:00
Adam Altman
9cad7e2e8d docs: rework assertions into custom rules (#917) 2022-11-02 06:58:54 -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
296ffe5637 sync: Synced local 'docs/' with remote 'docs/cli/' 2022-08-01 23:30:33 +00:00
redocly-bot
3e1bd1a968 sync: Synced local 'docs/' with remote 'docs/cli/' 2022-05-18 09:06:39 +00:00
Adam Altman
5e296e08e1 fix: fix heading level 2022-05-16 11:36:25 -05:00
redocly-bot
67c53ee8e7 sync: Synced local 'docs/' with remote 'docs/cli/' 2022-05-12 21:40:48 +00:00
redocly-bot
ee47cc3046 sync: Synced local 'docs/' with remote 'docs/cli/' 2022-05-11 02:04:53 +00:00
Roman Hotsiy
1cacff2044 chore: rename package to @redocly/cli (#672)
Co-authored-by: Andrew Tatomyr <andrew.tatomyr@gmail.com>
Co-authored-by: Ivana Isadora Devcic <skadinna@gmail.com>
2022-05-06 16:12:56 +02:00
redocly-bot
73048f7034 sync: Synced local 'docs/' with remote 'docs/cli/' 2022-05-05 01:02:23 +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
Jody Winter
2a23035e96 Update index.mdx (#598)
Co-authored-by: Ivana Isadora Devcic <33730345+skadinna@users.noreply.github.com>
2022-03-23 23:28:52 +01:00
redocly-bot
297082a16b sync: Synced local 'docs/' with remote 'docs/cli/' 2022-03-23 22:07:26 +00:00
redocly-bot
56d03ef884 sync: Synced local 'docs/' with remote 'docs/cli/' 2022-03-21 16:42:04 +00:00
redocly-bot
5b9cc9d714 sync: Synced local 'docs/' with remote 'docs/cli/' 2022-02-10 17:33:10 +00:00
redocly-bot
9cd808cfdf sync: Synced local 'docs/' with remote 'docs/cli/' 2022-02-09 20:12:59 +00:00
redocly-bot
000a25045d sync: Synced local 'docs/' with remote 'docs/cli/' 2022-01-07 19:53:01 +00:00
redocly-bot
15daa74a36 sync: Synced local 'docs/' with remote 'docs/cli/' 2021-12-14 10:50:45 +00:00
Andriy Leliv
5766f71a06 feat: support region for login and other commands (#459)
Co-authored-by: Ivana Isadora Devcic <skadinna@gmail.com>
2021-12-14 08:50:27 +02:00
redocly-bot
26e851a758 sync: Synced local 'docs/' with remote 'docs/cli/' 2021-11-24 11:11:07 +00:00
redocly-bot
5106bb18e4 sync: Synced local 'docs/' with remote 'docs/cli/' 2021-11-02 18:14:17 +00:00
redocly-bot
1936eb330d sync: Synced local 'docs/' with remote 'docs/cli/' 2021-10-10 21:59:57 +00:00
redocly-bot
4ff120daba sync: Synced local 'docs/' with remote 'docs/cli/' 2021-08-30 21:24:14 +00:00
redocly-bot
2143028637 sync: Synced local 'docs/' with remote 'docs/cli/' 2021-08-05 01:36:10 +00:00
Ivan Shvets
9f195d42ba feat: added basic docs folder sync configuration, added some ts libs 2021-06-15 15:22:46 +03:00