* docs: updated commands documentation per issue 1429 and minor corrections, ran prettier
* docs: updated commands documentation per issue 1429 and included pr 1560 feedback
* docs: minor formatting and copyedits
---------
Co-authored-by: Diana Cheung <18452752+dianacheung@users.noreply.github.com>
Co-authored-by: Lorna Mitchell <lorna.mitchell@redocly.com>
* feat(format): add support for GitHub Actions output format
* feat(lint): add support for GitHub Action output format
* doc: add changeset
* style: language hint on codeblock
* fix: include dependency in correct package
* refactor: remove dependency on @actions/core, do formatting of messages internally
* test: add coverage for github-actions output format
* style: format with prettier
* test: update snapshot for lint help output
* chore: update changeset to indicate minor version bump
* fix: undo local reference to @redocly/openapi-core
* Update .changeset/tame-gifts-tease.md
---------
Co-authored-by: Lorna Jane Mitchell <github@lornajane.net>
* 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>
* docs: tidy up lint doc, add JSON format
Rescue some changes from #665 that are worth keeping, and signpost the
rules documentation for configuration examples rather than having that
information duplicated here.
* docs: default value with variable description, anchors for renamed headings
* 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>
* docs: fully revised lint command for openapi-cli
* docs: second review stage of the lint cli command
* fix: phrasing issues
* Apply suggestions from code review
* docs: updated lint command according to mentions
* docs: added description for --extends option for lint command
* fix: phrasing issues
* docs: updated lint command document according to mentions
* docs: fixed incorrect link to configuration document in the lint command document
Co-authored-by: Ivana Isadora Devcic <33730345+skadinna@users.noreply.github.com>