Skip to content

docs: added quickstart guide for S3-Keploy #564

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,6 @@ The command starts a local development server and opens a browser window.

> 💡 **Tip:** After running `npm install`, use `npm start` to preview changes live at `http://localhost:3000/`.


## Running Vale Locally for Documentation Linting

To help maintain consistency in our documentation, we use Vale, a syntax-aware linter that checks for spelling, grammar, and style issues.
Expand Down
30 changes: 21 additions & 9 deletions STYLE.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Style Guidance

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

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/).

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

✅ **Correct:**
✅ **Correct:**

> “Next, Normalise the Test case on the Test run details page.”

❌ **Incorrect:**
❌ **Incorrect:**

> “Next, normalise the test case on the test run details.”

---
Expand All @@ -30,9 +32,11 @@ To reduce confusion, **always capitalize Keploy-specific terms** when referring
Use **sentence case** for all titles and headings. This means only the **first word** and **proper nouns** are capitalized.

✅ Correct:

> How to get started with Keploy

❌ Incorrect:

> How To Get Started With Keploy

---
Expand All @@ -43,10 +47,12 @@ Use **infinitive verb forms** (e.g., "to install", "to create", "to configure")
This improves searchability and aligns with common SEO practices.

✅ Correct:

> Install Keploy
> Create test cases

❌ Incorrect:

> Installing Keploy
> Creating test cases

Expand All @@ -55,13 +61,15 @@ This improves searchability and aligns with common SEO practices.
### 🧮 En Dashes in Ranges

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

✅ Correct:

- 5–10 GB
- 5 to 10 GB

❌ Incorrect:

- from 5-10 GB
- 5–10 GB and 10 to 20 MB (mixed style)

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

✅ Correct:

> Keploy records the API calls and generates test cases.

❌ Incorrect:

> The API calls are recorded and test cases are generated by Keploy.

---

### 🌍 Write for Global Readability

Use clear, simple, and **inclusive language**:

- Avoid jargon or unexplained acronyms.
- Provide context for technical terms.
- Prefer short, direct sentences.

✅ Better:

> After installing Go, use the following command to run Keploy.

❌ Confusing:

> Assuming GOPATH is set and your binaries are globally linked, execute Keploy.

---
Expand All @@ -98,10 +111,10 @@ Use clear, simple, and **inclusive language**:

- Wrap inline code using backticks: \`like this\`
- Use triple backticks for multi-line code blocks:
\`\`\`bash
npm install
npm run serve
\`\`\`
\`\`\`bash
npm install
npm run serve
\`\`\`
- Add comments in code examples where needed for clarity.

---
Expand All @@ -118,4 +131,3 @@ Use clear, simple, and **inclusive language**:
---

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

Loading