Skip to content

Commit 7cc30ce

Browse files
docs: fix formatting and spelling issues
Signed-off-by: Pratik Mahalle <[email protected]>
1 parent 59f7f00 commit 7cc30ce

File tree

6 files changed

+31
-29
lines changed

6 files changed

+31
-29
lines changed

vale_styles/config/vocabularies/Base/accept.txt

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -158,3 +158,8 @@ gqlgen
158158
ESLint
159159
llm
160160
gorm
161+
debian
162+
Ngrok
163+
Vet_List_All
164+
sanitization
165+
teardown

versioned_docs/version-2.0.0/keploy-explained/mac-linux.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -33,13 +33,13 @@ limactl create template://debian-12
3333
limactl start debian-12
3434
```
3535

36-
6. Enter the shell of the running linux instance
36+
6. Enter the shell of the running Linux instance
3737

3838
```bash
3939
limactl shell debian-12
4040
```
4141

42-
7. Now you are in the linux shell of the debian instance. Now, run the following command to go the `Users` into your directory
42+
7. Now you are in the Linux shell of the Debian instance. Now, run the following command to go to the `Users` directory
4343

4444
```bash
4545
cd /Users
@@ -64,23 +64,23 @@ sudo mkdir -p /usr/local/bin && sudo mv /tmp/keploy /usr/local/bin/keploy
6464
sudo apt-get -y install zsh
6565
```
6666

67-
**Why?** : zsh (Z Shell) is an advanced shell that offers enhanced features compared to the default bash shell. It provides better autocompletion, advanced globbing, improved history management, and more customization options.
67+
**Why?** : Zsh (Z Shell) is an advanced shell that offers enhanced features compared to the default bash shell. It provides better autocompletion, advanced globbing, improved history management, and more customization options.
6868

6969
11. Install Git
7070

7171
```bash
7272
sudo apt-get -y install git
7373
```
7474

75-
12. Install 'Oh-my-zsh'
75+
12. Install 'Oh My Zsh'
7676

7777
```bash
7878
sh -c "$(wget https://raw.githubusercontent.com/ohmyzsh/ohmyzsh/master/tools/install.sh -O -)"
7979
```
8080

81-
**Why?** : oh-my-zsh is a framework for managing your zsh configuration. It comes with a collection of plugins, themes, and helpful features that enhance the zsh experience.
81+
**Why?** : Oh My Zsh is a framework for managing your Zsh configuration. It comes with a collection of plugins, themes, and helpful features that enhance the Zsh experience.
8282

83-
13. Commands to Install docker
83+
13. Commands to Install Docker
8484

8585
```bash
8686
sudo apt-get -y update
@@ -117,7 +117,7 @@ sudo apt-get -y update
117117
sudo apt-get -y install docker-ce docker-ce-cli containerd.io docker-buildx-plugin docker-compose-plugin
118118
```
119119

120-
14. Add docker to sudoers
120+
14. Add Docker to sudoers
121121

122122
```bash
123123
sudo groupadd docker

versioned_docs/version-2.0.0/quickstart/java-spring-boot-openhospital.md

Lines changed: 9 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -23,19 +23,20 @@ keyword:
2323
- SQL
2424
- Java
2525
- Test OpenHospital
26-
- Junit
26+
- JUnit
2727
- React
2828
---
2929

30-
This is a openhospital app where you can record testcases and mocks by interacting with the UI, and then test them using Keploy.
30+
This is an OpenHospital app where you can record testcases and mocks by interacting with the UI, and then test them using Keploy.
3131

3232
import Link from '@docusaurus/Link'
3333

3434
import InstallationGuide from '../concepts/installation.md'
35+
import GetSupport from '../concepts/support.md'
3536

3637
<InstallationGuide/>
3738

38-
This project has Three parts - the UI, Core and API, since Keploy is a backend testing platform, we need to start the Backend of the project using Keploy and run the frontend as it is.
39+
This project has three parts - the UI, Core and API. Since Keploy is a backend testing platform, we need to start the Backend of the project using Keploy and run the frontend as it is.
3940

4041
## Setup the Core
4142

@@ -45,28 +46,27 @@ git checkout integration-with-keploy
4546
sudo apt install -y maven
4647
mvn clean install -DskipTests=true
4748
sudo docker compose up
48-
4949
```
5050

5151
## Setup the Backend
5252

53-
Now it's time to setup the backend of our application. Let's Download the Openhospital API and get started.
53+
Now it's time to set up the backend of our application. Let's download the OpenHospital API and get started.
5454

5555
```bash
5656
git clone https://github.com/keploy/openhospital-api
5757
git checkout integration-with-keploy
5858
mvn clean install -DskipTests=true
5959
```
6060

61-
You can start the Backend using Keploy cli:
61+
You can start the Backend using Keploy CLI:
6262

6363
# Instructions For Starting Using Binary
6464

6565
Prerequisites For Binary:
6666

6767
1. Node 20.11.0 LTS
6868
2. OpenJDK 17.0.9
69-
3. MVN version 3.6.3
69+
3. Maven version 3.6.3
7070

7171
## Recording the testcases with Keploy
7272

@@ -91,16 +91,13 @@ Now you can start interacting with the UI and Keploy will automatically create t
9191

9292
```bash
9393
keploy test -c "java -cp "target/openhospital-api-0.1.0.jar:rsc/:static/" org.springframework.boot.loader.launch.JarLauncher" --delay 40
94-
9594
```
9695

9796
🎉 Hooray! You've made it to the end of the binary section! 🎉
9897

99-
Here `delay` is the time it takes for your application to get started, after which Keploy will start running the testcases. If your application takes longer than 10s to get started, you can change the `delay` accordingly.
100-
`buildDelay` is the time that it takes for the image to get built. This is useful when you are building the docker image from your docker compose file itself.
98+
Here `delay` is the time it takes for your application to get started, after which Keploy will start running the testcases. If your application takes longer than 10 s to get started, you can change the `delay` accordingly.
99+
`buildDelay` is the time that it takes for the image to get built. This is useful when you are building the Docker image from your Docker Compose file itself.
101100

102101
Hope this helps you out, if you still have any questions, reach out to us .
103102

104-
import GetSupport from '../concepts/support.md'
105-
106103
<GetSupport/>

versioned_docs/version-2.0.0/quickstart/python-django-sql.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ keyword:
2222

2323
# Introduction
2424

25-
🪄 Dive into the world of User CRUD Apps and see how seamlessly Keploy integrated with Djangoand [PostgreSQL](https://www.postgresql.org/). Buckle up, it's gonna be a fun ride! 🎢
25+
🪄 Dive into the world of User CRUD Apps and see how seamlessly Keploy integrates with Django and [PostgreSQL](https://www.postgresql.org/). Buckle up, it's gonna be a fun ride! 🎢
2626

2727
import InstallationGuide from '../concepts/installation.md'
2828

@@ -257,7 +257,7 @@ Congrats on the journey so far! You've seen Keploy's power, flexed your coding m
257257

258258
Happy coding! ✨👩‍💻👨‍💻✨
259259

260-
**\*\*\*\***\*\*\*\*\***\*\*\*\*\***\*\*\*\*\***\*\*\*\*\***\*\*\*\*\***\*\*\*\*\***\_\_\_\***\*\*\*\*\***\*\*\*\*\***\*\*\*\*\***\*\*\*\*\***\*\*\*\*\***\*\*\*\*\***\*\*\***
260+
**\*\*\*\***\*\*\*\*\***\*\*\*\*\***\*\*\*\*\***\*\*\*\*\***\*\*\*\*\***\*\*\*\*\***\_\_\_\***\*\*\*\*\***\*\*\*\*\***\*\*\*\*\***\*\*\*\*\***\*\*\*\*\***\*\*\*\*\*
261261

262262
## Running App Locally on Linux/WSL 🐧
263263

versioned_docs/version-2.0.0/quickstart/samples-echo.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -147,7 +147,7 @@ Congrats on the journey so far! You've seen Keploy's power, flexed your coding m
147147

148148
Happy coding! ✨👩‍💻👨‍💻✨
149149

150-
**\*\*\*\***\*\*\*\*\***\*\*\*\*\***\*\*\*\*\***\*\*\*\*\***\*\*\*\*\***\*\*\*\*\***\_\_\_\***\*\*\*\*\***\*\*\*\*\***\*\*\*\*\***\*\*\*\*\***\*\*\*\*\***\*\*\***
150+
**\*\*\*\***\*\*\*\*\***\*\*\*\*\***\*\*\*\*\***\*\*\*\*\***\*\*\*\*\***\*\*\*\*\***\_\_\_\***\*\*\*\*\***\*\*\*\*\***\*\*\*\*\***\*\*\*\*\***\*\*\*\*\***\*\*\*\*\*
151151

152152
## Running App Locally on Linux/WSL 🐧
153153

versioned_docs/version-2.0.0/running-keploy/api-test-generator.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ keywords:
2020

2121
# Keploy API Testing Agent
2222

23-
Keploy's **API Testing Agent** allows you to auto-generate API test cases and mocks from real API usage data like `cURL` commands, OpenAPI schemas, or PRD/BRD documentspowered by LLMs.
23+
Keploy's **API Testing Agent** allows you to auto-generate API test cases and mocks from real API usage data like `cURL` commands, OpenAPI schemas, or PRD/BRD documentspowered by LLMs.
2424

2525
> 🚀 Zero-code setup. Paste real requests. Get test cases, mocks, and flaky test detection in minutes.
2626
@@ -35,7 +35,7 @@ Keploy's **API Testing Agent** allows you to auto-generate API test cases and mo
3535

3636
# Getting Started
3737

38-
This guide walks you through generating, editing, running, and managing automated API tests using Keploydemonstrated using the **PetClinic** application.
38+
This guide walks you through generating, editing, running, and managing automated API tests using Keploydemonstrated using the **PetClinic** application.
3939

4040
## Step 1: Login and Access the Testing Panel
4141

@@ -74,24 +74,24 @@ mvn clean -DskipTests install
7474
java -jar target/spring-petclinic-rest-3.0.2.jar
7575
```
7676

77-
### Expose the App Using ngrok
77+
### Expose the App Using Ngrok
7878

7979
```bash
8080
ngrok http http://localhost:9966
8181
```
8282

83-
Copy the generated ngrok URL (e.g., https://95777-115-245-249-101.ngrok-free.app)
83+
Copy the generated Ngrok URL (e.g., https://95777-115-245-249-101.ngrok-free.app)
8484

8585
Your Live Base URL will be:
8686

8787
```bash
8888
https://<your-ngrok-url>/petclinic/api
8989
```
9090

91-
### Step B: Setting up the pre-requisites
91+
### Step B: Setting up the prerequisites
9292

9393
**CURL Commands (Required):**
94-
Paste at least 35 working curl requests for the endpoints.
94+
Paste at least 35 working curl requests for the endpoints.
9595

9696
```bash
9797
# Test 1: GET all owners
@@ -619,7 +619,7 @@ From the dashboard, you can:
619619

620620
## Tips for Accurate Results
621621

622-
- Always paste at least 35 valid cURL commands
622+
- Always paste at least 35 valid cURL commands
623623
- Ensure your Live URL is active and responsive
624624
- Use OpenAPI schemas for better request/response modeling
625625
- Include real production-like inputs wherever possible

0 commit comments

Comments
 (0)