Skip to content

Commit 924d118

Browse files
chore: reformatting using prettier
Signed-off-by: Kumar Priyanshu <[email protected]>
1 parent dbc83b9 commit 924d118

File tree

2 files changed

+21
-10
lines changed

2 files changed

+21
-10
lines changed

README.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,6 @@ The command starts a local development server and opens a browser window.
7878

7979
> 💡 **Tip:** After running `npm install`, use `npm start` to preview changes live at `http://localhost:3000/`.
8080
81-
8281
## Running Vale Locally for Documentation Linting
8382

8483
To help maintain consistency in our documentation, we use Vale, a syntax-aware linter that checks for spelling, grammar, and style issues.

STYLE.md

Lines changed: 21 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Style Guidance
22

3-
Keploy documentation generally follows the [Google Developer Documentation Style Guide](https://developers.google.com/style).
3+
Keploy documentation generally follows the [Google Developer Documentation Style Guide](https://developers.google.com/style).
44

55
When the Google guide does not address a specific topic, we defer to the [Microsoft Writing Style Guide](https://docs.microsoft.com/en-us/style-guide/welcome/).
66

@@ -17,10 +17,12 @@ The following are Keploy-specific rules that override or expand on the Google an
1717
Some of Keploy’s core terms may also exist as generic terms in software or technical contexts.
1818
To reduce confusion, **always capitalize Keploy-specific terms** when referring to features or platform components. Generic usage should be lowercase and used sparingly.
1919

20-
**Correct:**
20+
**Correct:**
21+
2122
> “Next, Normalise the Test case on the Test run details page.”
2223
23-
**Incorrect:**
24+
**Incorrect:**
25+
2426
> “Next, normalise the test case on the test run details.”
2527
2628
---
@@ -30,9 +32,11 @@ To reduce confusion, **always capitalize Keploy-specific terms** when referring
3032
Use **sentence case** for all titles and headings. This means only the **first word** and **proper nouns** are capitalized.
3133

3234
✅ Correct:
35+
3336
> How to get started with Keploy
3437
3538
❌ Incorrect:
39+
3640
> How To Get Started With Keploy
3741
3842
---
@@ -43,10 +47,12 @@ Use **infinitive verb forms** (e.g., "to install", "to create", "to configure")
4347
This improves searchability and aligns with common SEO practices.
4448

4549
✅ Correct:
50+
4651
> Install Keploy
4752
> Create test cases
4853
4954
❌ Incorrect:
55+
5056
> Installing Keploy
5157
> Creating test cases
5258
@@ -55,13 +61,15 @@ This improves searchability and aligns with common SEO practices.
5561
### 🧮 En Dashes in Ranges
5662

5763
Use **en dashes (–)** to indicate numeric ranges. Do **not** mix styles or use hyphens inconsistently.
58-
You may also use words like *from*, *to*, or *through* — but be consistent throughout the doc.
64+
You may also use words like _from_, _to_, or _through_ — but be consistent throughout the doc.
5965

6066
✅ Correct:
67+
6168
- 5–10 GB
6269
- 5 to 10 GB
6370

6471
❌ Incorrect:
72+
6573
- from 5-10 GB
6674
- 5–10 GB and 10 to 20 MB (mixed style)
6775

@@ -72,24 +80,29 @@ You may also use words like *from*, *to*, or *through* — but be consistent thr
7280
Use **active voice** instead of passive voice to improve clarity and readability.
7381

7482
✅ Correct:
83+
7584
> Keploy records the API calls and generates test cases.
7685
7786
❌ Incorrect:
87+
7888
> The API calls are recorded and test cases are generated by Keploy.
7989
8090
---
8191

8292
### 🌍 Write for Global Readability
8393

8494
Use clear, simple, and **inclusive language**:
95+
8596
- Avoid jargon or unexplained acronyms.
8697
- Provide context for technical terms.
8798
- Prefer short, direct sentences.
8899

89100
✅ Better:
101+
90102
> After installing Go, use the following command to run Keploy.
91103
92104
❌ Confusing:
105+
93106
> Assuming GOPATH is set and your binaries are globally linked, execute Keploy.
94107
95108
---
@@ -98,10 +111,10 @@ Use clear, simple, and **inclusive language**:
98111

99112
- Wrap inline code using backticks: \`like this\`
100113
- Use triple backticks for multi-line code blocks:
101-
\`\`\`bash
102-
npm install
103-
npm run serve
104-
\`\`\`
114+
\`\`\`bash
115+
npm install
116+
npm run serve
117+
\`\`\`
105118
- Add comments in code examples where needed for clarity.
106119

107120
---
@@ -118,4 +131,3 @@ Use clear, simple, and **inclusive language**:
118131
---
119132

120133
> _Consistency leads to clarity. Let’s keep Keploy documentation clean, helpful, and easy to follow._
121-

0 commit comments

Comments
 (0)