Update contribution guide (#725)

* chore: update contribution guide

Signed-off-by: Achanandhi-M <achanandhi.m@gmail.com>

* chore: update contribution guide

Signed-off-by: Achanandhi-M <achanandhi.m@gmail.com>

---------

Signed-off-by: Achanandhi-M <achanandhi.m@gmail.com>

Author: Achanandhi-M

versioned_docs/version-3.0.0/keploy-explained/dev-guide.md

@@ -10,11 +10,11 @@ tags:
 
 # Contribution Guide 🚀
 
-Welcome to the world of Keploy development! Here, we'll get you up and running smoothly, making your Keploy journey a breeze.
+Welcome to the world of Keploy development! This guide will help you set up Keploy locally.
 
 ### 1. **Setting Up Your Platform**:
 
-Running Keploy on macOS or Windows? No problem! You'll need to create a Linux VM.
+_If you want to try Keploy on macOS or Windows, no worries — you’ll just need to set up a Linux VM._
 
 - For macOS, install [Lima](https://github.com/lima-vm/lima#installation).
 - If you're on Windows, install [WSL](https://learn.microsoft.com/en-us/windows/wsl/install).
@@ -25,28 +25,37 @@ Note: Linux Users are good to go.
 
 First things first, ensure you have [Golang](https://go.dev/doc/install) installed.
 
-### 3. **Cloning Keploy Repository**:
+### 3. **Clone Keploy Repository**:
 
-Time to get your hands on Keploy! Run these commands to clone the repository and download those Go dependencies:
+Time to get your hands on Keploy!:
 
 ```shell
 git clone https://github.com/keploy/keploy.git && cd keploy
 go mod download
 ```
 
-### 4. Running Keploy on v2:
+Once done, build the binary
 
-The Keploy CLI operates by capturing all network traffic between your application and its dependencies.
-It meticulously records API calls, database queries, and any other interactions your application engages in.
+```shell
+go build -race -tags=viper_bind_struct -o keploy .
+sudo mv keploy /usr/local/bin/
+sudo chmod +x /usr/local/bin/keploy
+```
 
-Once the recording phase is complete, Keploy can effortlessly generate test cases and data mocks in YAML format.
+**_Now we have successfully set up Keploy. Let’s test it with the sample app._**
 
 #### Keploy operates in two modes:
 
 - `record`: Capture Keploy test cases from API calls.
 - `test`: Execute recorded test cases and validate assertions.
 
-To dive into Keploy, you can use the [gin-mongo URL Shortener](https://github.com/keploy/samples-go/tree/main/gin-mongo) sample application:
+The Keploy CLI operates by capturing all network traffic between your application and its dependencies.
+
+It meticulously records API calls, database queries, and any other interactions your application engages in.
+
+Once the recording phase is complete, Keploy can effortlessly generate test cases and data mocks in YAML format.
+
+If you don't have any samples app, you can use the [gin-mongo URL Shortener](https://github.com/keploy/samples-go/tree/main/gin-mongo) sample application:
 
 #### Let's clone sample app repo:
 
@@ -56,110 +65,50 @@ go mod download   # Download dependencies:
 go build -o gin-mongo-binary  # Generate binary of the application:
 ```
 
-### Now let's try running keploy:
-
-#### Capturing Test Cases:
-
-```shell
- go run -exec "sudo -E env 'PATH=$PATH'" -tags=viper_bind_struct main.go record -c "path/to/go/binary/of/application"
-```
-
-After entering record mode, send requests to your application to generate test cases.
-
-#### Running Test Cases:
-
-```shell
-go run -exec "sudo -E env 'PATH=$PATH'" -tags=viper_bind_struct main.go test -c "path/to/go/binary/of/application" --delay 10
-```
-
-Run Keploy server to expose test APIs:
-
-```shell
-go run -exec "sudo -E env 'PATH=$PATH'" -tags=viper_bind_struct main.go test -c "path/to/go/binary/of/application" --delay 10 --coverage
-```
-
-Generated test cases can be found inside the Keploy directory.
-
-### 5. Setup Keploy using Binary:
-
-#### Generate Keploy Binary:
-
-```shell
-go build -race -tags=viper_bind_struct -o keploy . && sudo mv keploy /usr/local/bin
-```
+### 4. Now let's try running keploy:
 
 #### Capturing Test Cases:
 
 ```shell
-sudo -E env PATH="$PATH" keploy record -c "path/to/go/binary"
+sudo keploy record -c "path/to/go/binary"
 ```
 
 #### Running Test Cases:
 
 ```shell
-sudo -E env PATH="$PATH" keploy test -c "path/to/go/binary" --delay 10
+sudo keploy test -c "path/to/go/binary" --delay 10
 ```
 
 Note: Use the `--debug` flag to run Keploy in debug mode for detailed logs.
 
-### 6. Setup Keploy via Docker:
-
-#### Install the Keploy Docker Image:
-
-```shell
-docker pull ghcr.io/keploy/keploy
-```
-
-#### Create Keploy Alias:
-
-```shell
-alias keployV2='sudo docker run --pull always --name keploy-v2 -p 16789:16789 --network keploy-network --privileged --pid=host -it -v $(pwd):$(pwd) -w $(pwd) -v /sys/fs/cgroup:/sys/fs/cgroup -v /sys/kernel/debug:/sys/kernel/debug -v /sys/fs/bpf:/sys/fs/bpf -v /var/run/docker.sock:/var/run/docker.sock --rm ghcr.io/keploy/keploy'
-```
-
-#### Capture Test Cases:
-
-```shell
-keployV2 record -c "docker run -p 8080:8080 --name <containerName>  --network keploy-network --rm <imageName>"" --containerName  <containerName>
-```
-
-#### Running Test Cases:
-
-```shell
-keployV2 test --c "docker run -p 8080:8080  --name <containerName> --network keploy-network --rm <imageName>" --delay 10
-```
-
-### 7. Testing Locally Built Docker Image:
+### Also you can Test Locally Built Docker Image:
 
 #### Build Docker Image:
 
-Run the below command inside the keploy respository and make sure there is no directory by the name of keploy inside the main keploy repository.
+Note: Run the below command inside the keploy respository and make sure there is no directory by the name of keploy inside the main keploy repository.
 
 ```shell
 sudo docker image build -t ghcr.io/keploy/keploy:v2-dev .
 ```
 
-#### Create Alias:
-
-```shell
-alias keployV2='sudo docker run --name keploy-v2 -p 16789:16789 --privileged --pid=host -it -v $(pwd):$(pwd) -w $(pwd) -v /sys/fs/cgroup:/sys/fs/cgroup -v /sys/kernel/debug:/sys/kernel/debug -v /sys/fs/bpf:/sys/fs/bpf -v /var/run/docker.sock:/var/run/docker.sock -v '"$HOME"'/.keploy-config:/root/.keploy-config -v '"$HOME"'/.keploy:/root/.keploy --rm ghcr.io/keploy/keploy:v2-dev'
-```
-
-#### Remember setting up the Keploy binary. See [Setup Keploy using Binary](#5-setup-keploy-using-binary) for details.
+#### Remember setting up the Keploy binary. See [Setup Keploy using Binary](#3-clone-keploy-repository) for details.
 
 #### Capture Test Cases:
 
 ```shell
-sudo -E env PATH="$PATH" keployV2 record -c "docker run -p 8080:8080 --name <containerName>  --network keploy-network --rm <imageName>"" --containerName  <containerName>
+sudo keploy record -c "docker run -p -p <appPort>:<hostPort>  --name <containerName> --network keploy-network --rm <imageName>"
 ```
 
 #### Running Test Cases:
 
 ```shell
-sudo -E env PATH="$PATH" keployV2 test --c "docker run -p 8080:8080  --name <containerName> --network keploy-network --rm <imageName>" --delay 10
+sudo keploy test -c "docker run -p -p <appPort>:<hostPort>  --name <containerName> --network keploy-network --rm <imageName>" --delay 10
 ```
 
-There you have it! With this guide, you're all set to dive into Keploy development. Happy testing! 🧪🔍💻
+There you have it! With this guide, you're all set to dive into Keploy development.
+
+Happy testing! 🧪🔍💻
 
 > **Note** :- Run `go run github.com/99designs/gqlgen generate --config pkg/graph/gqlgen.yml` to generate the graphql server stubs which can be used when working with unit testing libraries like JUnit, PyTest, etc..
 
-Hope this helps you out, if you still have any questions, reach out to us .
+Hope this helps you out, if you still have any questions, reach out to us on [slack](https://keploy.slack.com/join/shared_invite/zt-357qqm9b5-PbZRVu3Yt2rJIa6ofrwWNg) .

versioned_docs/version-3.0.0/keploy-explained/docs-dev-guide.md

@@ -1,35 +1,41 @@
 ---
 id: docs-dev-guide
-title: docs-dev-guide
+title: Keploy Docs Contribution Guide
 sidebar_label: Docs Dev Guide
 tags:
   - dev guide
   - explanation
   - contributing
 ---
 
-# How to contribute
+We welcome and appreciate contributions from the community. There are several ways you can help improve the documentation:
 
-We encourage contributions from the community.
+### Ways to Contribute:
 
-**Create a [GitHub issue](https://github.com/keploy/docs/issues) for any changes beyond typos and small fixes.**
+**1. Code Contribution**.
 
-If you do create a pull request (PR), please follow our style guidance.
+**2. Report bugs or suggest improvements**.
 
-We review GitHub issues and PRs on a regular schedule.
+**3. Suggest UI/UX enhancements**.
+
+**4. Contribute to translations**.
+
+Your contributions help strengthen the documentation and support the Keploy community
+
+**Note: Create a [GitHub issue](https://github.com/keploy/keploy/issues/new/choose) for any changes beyond typos and small fixes.**
+
+If you do create a pull request (PR) or Github issues, please follow our style guidance.
 
-To ensure that each change is relevant and properly peer reviewed, please adhere to best practices for open-source contributions.
-This means that if you are outside the Keploy organization, you must fork the repository and create PRs from branches on your own fork.
 The README in GitHub's [first-contributions repo](https://github.com/firstcontributions/first-contributions) provides an example.
 
 ## How to set up the docs website locally?
 
-The Keploy documentation site uses Docusaurus 2 which is a static website generator.
+The Keploy documentation site uses Docusaurus which is a static website generator.
 
 You can make changes locally without previewing them in the browser.
-However, if you want to build the site and preview changes in the browser, you need to have Docusaurus 2 dependencies installed.
+However, if you want to build the site and preview changes in the browser, you need to have Docusaurus dependencies installed.
 
-Initialize Docusaurus 2 in the repo by running [`yarn`](https://classic.yarnpkg.com/en/docs/cli/) or [`npm`](https://docs.npmjs.com/cli/v10) once in the root directory of the repo.
+Initialize Docusaurus in the repo by running [`yarn`](https://classic.yarnpkg.com/en/docs/cli/) or [`npm`](https://docs.npmjs.com/cli/v10) once in the root directory of the repo.
 
 Now you can build and view the site locally:
 

versioned_sidebars/version-3.0.0-sidebars.json

@@ -245,10 +245,7 @@
       "collapsible": true,
       "items": [
         "keploy-explained/contribution-guide",
-        "keploy-explained/docs-dev-guide",
-        "keploy-explained/debugger-guide",
-        "keploy-explained/testing-guide",
-        "keploy-explained/mac-linux"
+        "keploy-explained/docs-dev-guide"
       ]
     }
   ]