* docs: add mlc config and github action to check links
Ignores relative links since we can only check those from the main
website project.
* docs: update redirecting links and configure some ignore patterns
* 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>
* Update quickstart.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 worked fine.
* Update docs/quickstart.md
Co-authored-by: Ivana Isadora Devcic <33730345+skadinna@users.noreply.github.com>
* Update quickstart.md
Second draft, post-reviews.
* fix: minor text formatting and phrasing changes
* Update docs/quickstart.md
Co-authored-by: Ivana Isadora Devcic <33730345+skadinna@users.noreply.github.com>
* Update docs/quickstart.md
Co-authored-by: Ivana Isadora Devcic <33730345+skadinna@users.noreply.github.com>
* Update docs/quickstart.md
Co-authored-by: Ivana Isadora Devcic <33730345+skadinna@users.noreply.github.com>
* Update quickstart.md
Updated based on review feedback.
* Respond to suggested change
* fix: internal links
Co-authored-by: Ivana Isadora Devcic <33730345+skadinna@users.noreply.github.com>
Co-authored-by: Swapnil Ogale <swapnilogale@gmail.com>
