Merge branch 'main' into lint-issue

Signed-off-by: Pratik Mahalle <[email protected]>

Author: pratik-mahalle

README.md

@@ -120,10 +120,10 @@ MinAlertLevel = error
 
 ### Running Vale
 
-1. Linting Documentation: To check all markdown files in versioned_docs/version-2.0.0/ for errors, run:
+1. Linting Documentation: To check all markdown files in versioned_docs/version-3.0.0/ for errors, run:
 
 ```bash
-vale versioned_docs/version-2.0.0/**/*.md
+vale versioned_docs/version-3.0.0/**/*.md
 ```
 
 2. Review Errors:

versioned_docs/version-3.0.0/quickstart/python-flask-mongo.md

@@ -214,12 +214,14 @@ We'll be running our sample application right on Linux, but just to make things
 pip install -r requirements.txt
 ```
 
-## Start the MongoDB server
+## Start the MongoDB container
 
 ```bash
-sudo service mongod start
+docker run -p 27017:27017 -d --network backend --name mongo mongo
 ```
 
+> **Since we are using a MongoDB container, we need to update the `client` on line 11 in `app.py`, to `localhost`.**
+
 ## Lights, Camera, Record! 🎥
 
 To initiate the recording of API calls, execute this command in your terminal:

versioned_docs/version-3.0.0/running-keploy/cli-commands.md

@@ -299,14 +299,30 @@ keploy normalize [flags]
 
 ## [rerecord](#rerecord)
 
-The `rerecord`cmd allow user to record new keploy testcases/mocks from the existing test cases for the given testsets.
+The `rerecord` command allows users to record new Keploy test cases and mocks from existing test cases for the given testset(s).
 
-<b> Usage: </b>
+**Usage:**
 
 ```bash
 keploy rerecord -c "node src/app.js" -t "test-set-0"
 ```
 
+**Docker Example:**
+
+To re-record test cases for an application running inside a Docker container, use the Docker run command as the value for the `-c` flag:
+
+```bash
+keploy rerecord -c "sudo docker run -p 5000:5000 --name flask-jwt-app --network keploy-network flask-jwt-app" -t "test-set-0" --delay 10
+```
+
+**`--delay` flag:**
+
+The `--delay` flag specifies the number of seconds Keploy should wait after starting your application before replaying requests to re-record.
+This is useful if your application takes some time to start (for example, when running inside a Docker container or a heavy framework).
+
+- Adjust the delay to match your app's startup time.
+- For example, use `--delay 10` to wait for 10 seconds.
+
 ## [templatize](#templatize)
 
 The `templatize` cmd allows the user to templatize important fields in the testcases who's values are used in the request of testcases and that may change in the future.

versioned_docs/version-3.0.0/running-keploy/configuration-file.md

@@ -238,6 +238,25 @@ The tests section enables you to specify conditions for recording tests during A
 
 You can use the **`path`**, **`urlMethods`**, **`headers`**, and **`host`** filters together or independently based on your testing scenarios. This flexibility allows you to precisely define the conditions under which tests are recorded.
 
+### Managing Secrets with `secret.yaml`
+
+Keploy allows you to manage sensitive information like API keys or tokens securely, without hardcoding them into your test files. This is done using a `secret.yaml` file within each test set directory.
+
+1.  **Create `secret.yaml`**: Inside your test set directory (e.g., `keploy/test-set-0/`), create a file named `secret.yaml`.
+
+2.  **Define Your Secrets**: Add your secrets as key-value pairs.
+
+    ```yaml
+    Authorization: Bearer xyz.abc.123
+    ```
+
+3.  **Use Secrets in Tests**: Reference these values in your test cases or mocks using the `{{.secret.KEY}}` syntax.
+    ```yaml
+    header:
+      Authorization: "{{string .secret.Authorization }}"
+    ```
+    For your security, Keploy will automatically add `/*/secret.yaml` to your `.gitignore` file to prevent accidentally committing secrets.
+
 ### Bypass Rules Section
 
 The `bypassRules` section in the Keploy-config file allows you to define parameters for bypassing and mocking API calls.

versioned_docs/version-3.0.0/running-keploy/generate-api-tests-using-ai.md

@@ -7,7 +7,7 @@ description: Learn how to use Keploy’s API Test Generator to generate high-qua
 
 This guide will help you generate automated API tests using Keploy's AI-based test engine by providing structured inputs like OpenAPI specs, curl commands, Postman collections, or live endpoints.
 
-> 👉 If you want to record API flows by interacting with your web app through a browser, follow this guide instead: Record API Tests via Chrome Extension
+> 👉 If you want to record API flows by interacting with your web app through a browser, follow this guide instead: [Record API Tests via Chrome Extension](https://keploy.io/docs/running-keploy/api-testing-chrome-extension/)
 
 ## Getting Started
 

versioned_docs/version-3.0.0/running-keploy/review-and-improve-ai-generated-tests.md

@@ -70,7 +70,8 @@ Mix-and-match them as needed—every example below can live inside the same `ass
 | **Header Exists**     | Header key is present (value ignored).                 | `yaml<br>- type: header_exists<br>  field: x-request-id<br>`                                               | Reverse-proxy injects `x-request-id: 4b087…`                                 |
 | **Header Matches**    | Header value matches a **regex** pattern.              | `yaml<br>- type: header_matches<br>  field: set-cookie<br>  pattern: "sessionId=.*; Path=/; HttpOnly"<br>` | `set-cookie: sessionId=abc123; Path=/; HttpOnly; SameSite=Lax`               |
 
-> **Tip 🛠️**  
+> **Tip**  
+
 > Combine multiple assertions in one step to cover status, headers **and** body in a single round-trip. Every assertion is evaluated independently, so one failure pinpoints the exact mismatch.
 
 ## Edit or Delete a Test Suite