Skip to content

Commit bc35914

Browse files
authored
docs: update bug-report template and README (#2388)
1 parent 2367722 commit bc35914

File tree

2 files changed

+22
-12
lines changed

2 files changed

+22
-12
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 20 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -11,12 +11,15 @@ assignees: ''
1111
<!-- A clear and concise description of what the bug is. -->
1212

1313
**To Reproduce**
14-
Steps to reproduce the behavior:
14+
15+
<!--
16+
Steps to reproduce the behavior, e.g.:
1517
1618
1. Given this `redocly.yaml` file
1719
2. And this OpenAPI file(s)
18-
3. Run this command with these arguments... `redocly ...`
19-
4. See error
20+
3. Run this command with these arguments: `redocly ...`
21+
4. See the error
22+
-->
2023

2124
**Expected behavior**
2225

@@ -28,21 +31,28 @@ Steps to reproduce the behavior:
2831

2932
**OpenAPI description**
3033

31-
<!-- If applicable, add an OpenAPI description and `redocly.yaml` configuration file that helps reproduce the problem.
32-
At a minimum, please state the specification and version(s) you're using. -->
34+
<!--
35+
If applicable, add an OpenAPI description and `redocly.yaml` configuration file that helps reproduce the problem.
36+
At a minimum, please state the specification and version(s) you're using.
37+
-->
3338

34-
**Redocly Version(s)**
39+
**Redocly version(s)**
3540

3641
<!-- What version of Redocly CLI are you using? -->
3742

38-
**`Node.js` Version(s)**
43+
**Node.js version(s)**
3944

40-
<!-- What version of `node.js` and `npm` are you using? -->
45+
<!-- What version of Node.js and NPM are you using? -->
4146

4247
**OS, environment**
4348

44-
<!-- What OS are you using? -->
49+
<!-- Which operating system are you using? -->
4550

4651
**Additional context**
4752

48-
<!-- Add any other context about the problem here. -->
53+
<!--
54+
Add any other context about the problem here, for example:
55+
- Are you trying to run the command for the first time?
56+
- Has it worked before?
57+
- What was the last working version?
58+
-->

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Redocly CLI
22

3-
[@Redocly](https://redocly.com) CLI is your all-in-one OpenAPI utility.
4-
It builds, manages, improves, and quality-checks your OpenAPI descriptions, all of which comes in handy for various phases of the API Lifecycle.
3+
[@Redocly](https://redocly.com) CLI is your all-in-one API documentation utility.
4+
It builds, manages, improves, and quality-checks your API descriptions, all of which comes in handy for various phases of the API Lifecycle.
55
Create your own rulesets to make API governance easy, publish beautiful API reference documentation, and more.
66
Supports OpenAPI 3.2, 3.1, 3.0 and OpenAPI 2.0 (legacy Swagger), AsyncAPI 3.0 and 2.6, Arazzo 1.0.
77

0 commit comments

Comments
 (0)