* docs: add a guide for linting and bundling as two separate but chained commands
* Apply suggestions from code review
Co-authored-by: Heather Cloward <heathercloward@gmail.com>
* docs: reformat wrapping
* docs: grammar fix for guides index page
* Update docs/guides/lint-and-bundle.md
Co-authored-by: Heather Cloward <heathercloward@gmail.com>
---------
Co-authored-by: Heather Cloward <heathercloward@gmail.com>
* 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>
* chore: progress on asyncapi
* chore: more progress
* chore: enable assertions
* Feat: Start adding protocol-specific channel bindings
* Feat: flesh out components fields
* Fix: remove link and x-code-sample, not supported for asyncapi
* Feat: Add solace protocol support
* chore: refactor channel/server bindings to define and add to collection
* chore: re-order nodes to group by protocol
* chore: re-order node listings to also group by protocol
* feat: add topicConfiguration for Kafka and fix a typo
* feat: rename ServerMap for clarity
* feat: Add message bindings, remove incomplete protocols
* fix: a few tests were failing after original refactoring
* feat: add MessageTrait object
* feat: Add operation bindings, export operation and message bindings
* Feat: add a few rules for asyncapi, create channels-kebab-case
* fix: Add messageBindings and operationBindings to components section
* feat: Add no-channel-trailing-slash rule for asyncapi
* fix: Update allowed/required list for httpAPIkey
* chore: add tests for new AsyncAPI rules
* Feat: Add sample asyncapi descriptions as tests
* chore: generate snapshot.js for async-api tests
* chore: fix some minor drift between main branch and this one after
rebasing
* docs: add a guide to linting AsyncAPI
* fix: broken links in guide
* chore: run prettier
* chore: update test snapshot
* chore: clean up comments and stray log message
* docs: Update from review feedback, and add a health warning
* Update packages/core/src/config/config-resolvers.ts
Co-authored-by: Andrew Tatomyr <andrew.tatomyr@redocly.com>
* fix: allow async2 as the only feature in custom plugins
* chore: add tests and tweak error messages for document type detection
* chore: fix tests and rename majorSpecVersion->getMajorSpecVersion
* chore: run prettier
* chore: Tidy and improve comments in main asyncapi types file
* chore: remove outdated comment
* fix: remove extraneous empty extends from guide and tests
* docs: Add changeset for AsyncAPI feature
* Update .changeset/quick-emus-punch.md
Co-authored-by: Andrew Tatomyr <andrew.tatomyr@redocly.com>
---------
Co-authored-by: Lorna Mitchell <lorna.mitchell@redocly.com>
Co-authored-by: SmoliyY <yevhen.smoliy@gmail.com>
Co-authored-by: Lorna Jane Mitchell <github@lornajane.net>
Co-authored-by: Andrew Tatomyr <andrew.tatomyr@redocly.com>
* 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: Draft of spectral migration guide
* docs: add redocly and spectral rules list
* docs: fix configurable rule example and some links, add a punchline
* docs: Expand on the custom and configurable rules options
* fix: a broken link
* 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: 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>
* docs: add guide to hide custom openapi extensions
* docs: update naming consistency in guide on how to hide openapi extensions
* Rename hide-custom-extensions.md to hide-specification-extensions.md
* docs: change custom extensions to specification extensions
- change file name and links
- change code
- change inline text links
- minor other changes
- fix OpenAPI capitalization
Co-authored-by: Adam Altman <adam@redoc.ly>
* docs: refactor response-contains-property guide
This refactor includes:
- switch content to describe a new built-in rule instead of an old custom one
- case when one response contains one property
- case when multiple responses contain one property
- case when multiple responses contain multiple properties
- short description of status code priority
* docs: add link to gist for the response-contains-property guide
In this update there is a link to the corresponding gist that is
used for the response-contains-property guide
* docs: minify assets for response contains property guide. Update links with alt text
* docs: resolve review comments in response-contains-property guide
* docs: change npm test to npx redocly lint. Update command listings
* chore: fix broken image paths
Co-authored-by: Adam Altman <adam@redoc.ly>
