Commit Graph

5 Commits

Author SHA1 Message Date
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
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
Ihor Karpiuk
fba8990251 docs: add docs for spec-strict-refs rule (#1118) 2023-06-07 11:22:26 +03: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