Skip to content

Commit 85f12d6

Browse files
authored
docs(all): feedback updates cli (Redocly#2093)
* docs(all): fix confusing link * docs(all): updates openapi link in struct files in v1 and v2 * docs(all): changes in files: tag description, path-not-include query, swagger cli * docs(all): changes in files for v2: tag description, path-not-include-query, swagger cli
1 parent 441a086 commit 85f12d6

File tree

10 files changed

+12
-12
lines changed

10 files changed

+12
-12
lines changed

docs/@v1/custom-plugins/visitor.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ This works fine for most context-free rules. If you need contextual info you sho
4545

4646
## Nested visitors
4747

48-
The visitor object (if it is not `any` or `ref`) can define [nested visitors](#nested-visitors).
48+
The visitor object (if it is not `any` or `ref`) can define nested visitors.
4949

5050
Here is a basic example of a nested visitor:
5151

docs/@v1/guides/migrate-from-swagger-cli.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ The configuration in the `redocly.yaml` file should look like this:
3434
```yaml
3535
extends: []
3636

37-
rule:
37+
rules:
3838
spec: error
3939
```
4040

docs/@v1/rules/oas/path-not-include-query.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ An example configuration:
2929

3030
```yaml
3131
rules:
32-
path-not-included-query: error
32+
path-not-include-query: error
3333
```
3434
3535
## Examples
@@ -38,7 +38,7 @@ Given this configuration:
3838
3939
```yaml
4040
rules:
41-
path-not-included-query: error
41+
path-not-include-query: error
4242
```
4343
4444
Example of an **incorrect** path:

docs/@v1/rules/oas/struct.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,4 +67,4 @@ paths: {}
6767
6868
## Resources
6969
70-
- [OpenAPI docs](https://redocly.com/docs/openapi-visual-reference/)
70+
- [OpenAPI docs](https://redocly.com/learn/openapi/learning-openapi)

docs/@v1/rules/oas/tag-description.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ Set the desired [severity](../../rules.md#severity-settings) for the rule.
4545

4646
```yaml
4747
rules:
48-
info-contact: error
48+
tag description: error
4949
```
5050
5151
| Option | Type | Description |

docs/@v2/custom-plugins/visitor.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ This works fine for most context-free rules. If you need contextual info you sho
4545

4646
## Nested visitors
4747

48-
The visitor object (if it is not `any` or `ref`) can define [nested visitors](#nested-visitors).
48+
The visitor object (if it is not `any` or `ref`) can define nested visitors.
4949

5050
Here is a basic example of a nested visitor:
5151

docs/@v2/guides/migrate-from-swagger-cli.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ The configuration in the `redocly.yaml` file should look like this:
3434
```yaml
3535
extends: []
3636

37-
rule:
37+
rules:
3838
struct: error
3939
```
4040

docs/@v2/rules/oas/path-not-include-query.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ An example configuration:
2929

3030
```yaml
3131
rules:
32-
path-not-included-query: error
32+
path-not-include-query: error
3333
```
3434
3535
## Examples
@@ -38,7 +38,7 @@ Given this configuration:
3838
3939
```yaml
4040
rules:
41-
path-not-included-query: error
41+
path-not-include-query: error
4242
```
4343
4444
Example of an **incorrect** path:

docs/@v2/rules/oas/struct.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,4 +67,4 @@ paths: {}
6767
6868
## Resources
6969
70-
- [OpenAPI docs](https://redocly.com/docs/openapi-visual-reference/)
70+
- [OpenAPI docs](https://redocly.com/learn/openapi/learning-openapi)

docs/@v2/rules/oas/tag-description.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ Set the desired [severity](../../rules.md#severity-settings) for the rule.
4545

4646
```yaml
4747
rules:
48-
info-contact: error
48+
tag-description: error
4949
```
5050
5151
| Option | Type | Description |

0 commit comments

Comments
 (0)