Commit Graph

19 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
Heather Cloward
b0ce87dd46 docs: updates redocly-cli landing page to have tiles instead of bullets (#1103)
* docs: updates redocly-cli landing page to have tiles instead of bullets

* docs: updated Redoc link on main landing page to a more appropriate page

* docs: fix broken link

* docs: updates per Lorna's review

* docs: adjust wording to fit tiles

* docs: removes old index.md file

* docs: removes future tense from index.mdx

---------

Co-authored-by: Lorna Mitchell <lorna.mitchell@redocly.com>
2023-06-02 12:31:22 -04: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
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
Adam Altman
9cad7e2e8d docs: rework assertions into custom rules (#917) 2022-11-02 06:58:54 -05:00
redocly-bot
a73c884b2c sync: Synced local 'docs/' with remote 'docs/cli/' 2022-08-03 12:21:37 +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
d622c06d5c sync: Synced local 'docs/' with remote 'docs/cli/' 2022-03-24 12:46:26 +00:00
Jody Winter
f4a26b7ab3 Update index.md (#576)
* Update index.md

I used Open Weather Map’s Current Weather Data API for testing as I know we need to stop using petstore. This is the API that is used throughout Tom Johnson’s API docs course. I tested all commands and everything passed.

* Update docs/index.md

Co-authored-by: Ivana Isadora Devcic <33730345+skadinna@users.noreply.github.com>

* Update docs/index.md

Co-authored-by: Ivana Isadora Devcic <33730345+skadinna@users.noreply.github.com>

* Update docs/index.md

Co-authored-by: Ivana Isadora Devcic <33730345+skadinna@users.noreply.github.com>

* Update docs/index.md

Co-authored-by: Ivana Isadora Devcic <33730345+skadinna@users.noreply.github.com>

* Update docs/index.md

Co-authored-by: Ivana Isadora Devcic <33730345+skadinna@users.noreply.github.com>

* Update index.md

Second pass.

* Updated refs to config file

Standardised naming ('the Redocly configuration file' or 'redocly.yaml' instead of '.redocly.yaml').

Co-authored-by: Ivana Isadora Devcic <33730345+skadinna@users.noreply.github.com>
Co-authored-by: Swapnil Ogale <swapnilogale@gmail.com>
2022-03-24 15:26:11 +11:00
redocly-bot
5b9cc9d714 sync: Synced local 'docs/' with remote 'docs/cli/' 2022-02-10 17:33:10 +00:00
redocly-bot
1b520bbf6f sync: Synced local 'docs/' with remote 'docs/cli/' 2021-09-20 14:19:21 +00:00
redocly-bot
e7b76e932c sync: Synced local 'docs/' with remote 'docs/cli/' 2021-09-02 21:19:23 +00:00
redocly-bot
4ff120daba sync: Synced local 'docs/' with remote 'docs/cli/' 2021-08-30 21:24:14 +00:00
Antonio
c463fc42df docs: revised openapi-cli overview page (#334)
* docs: revised openapi-cli overview page

* docs: fixed mentions related to OAS support

* docs: Modified the title of admonition in the overview page
2021-08-24 14:27:33 -05:00
redocly-bot
91759e1480 sync: Synced local 'docs/' with remote 'docs/cli/' 2021-08-19 01:22:29 +00:00
Antonio
5425624d29 docs: added information about openapi-cli benefits and advantages (#338) 2021-08-18 18:35:21 -05:00
redocly-bot
851f197752 sync: Synced local 'docs/' with remote 'docs/cli/' 2021-07-26 15:03:46 +00:00
Ivan Shvets
9f195d42ba feat: added basic docs folder sync configuration, added some ts libs 2021-06-15 15:22:46 +03:00