Skip to content

Commit 68e6c58

Browse files
docs: add docs about duplicating rules and bundle components (#2812)
1 parent 214c605 commit 68e6c58

2 files changed

Lines changed: 2 additions & 0 deletions

File tree

CONTRIBUTING.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -178,6 +178,7 @@ The defaults are `off` or `warn` for `minimal` and `recommended` and `error` for
178178
Also add the rule to the built-in rules list in [the config types tree](./packages/core/src/types/redocly-yaml.ts).
179179

180180
If the rule reflects a specification requirement, prefix it with `spec-` and add it to the [spec ruleset](./packages/core/src/config/spec.ts).
181+
If a rule already exists for another specification flavor, reuse the existing name so the same concept stays discoverable across specs.
181182

182183
Separately, open a merge request with the corresponding documentation changes.
183184
To make changes to documentation:

docs/@v2/commands/bundle.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ The `bundle` command pulls the relevant parts of an API description into a singl
1111

1212
The `bundle` command differs from the [`join`](./join.md) command.
1313
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.
14+
All components are automatically resolved and included without requiring explicit definitions.
1415
The `join` command can combine multiple OpenAPI files into a single unified API description file.
1516

1617
The `bundle` command first executes preprocessors, then rules, then decorators.

0 commit comments

Comments
 (0)