diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index fd7c4a38cb..80ffec9cfd 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -178,6 +178,7 @@ The defaults are `off` or `warn` for `minimal` and `recommended` and `error` for Also add the rule to the built-in rules list in [the config types tree](./packages/core/src/types/redocly-yaml.ts). If the rule reflects a specification requirement, prefix it with `spec-` and add it to the [spec ruleset](./packages/core/src/config/spec.ts). +If a rule already exists for another specification flavor, reuse the existing name so the same concept stays discoverable across specs. Separately, open a merge request with the corresponding documentation changes. To make changes to documentation: diff --git a/docs/@v2/commands/bundle.md b/docs/@v2/commands/bundle.md index 528087f5de..e9d72f0313 100644 --- a/docs/@v2/commands/bundle.md +++ b/docs/@v2/commands/bundle.md @@ -11,6 +11,7 @@ The `bundle` command pulls the relevant parts of an API description into a singl The `bundle` command differs from the [`join`](./join.md) command. The `bundle` command takes a root OpenAPI file as input and follows the `$ref` mentions to include all the referenced components into a single output file. +All components are automatically resolved and included without requiring explicit definitions. The `join` command can combine multiple OpenAPI files into a single unified API description file. The `bundle` command first executes preprocessors, then rules, then decorators.