Merge branch 'main' into fix-broken-url

Author: Achanandhi-M

README.md

@@ -10,7 +10,8 @@ Repository for the Keploy documentation website.
 </p>
 </div>
 
-**Note** :- Issue Creation is disabled on this Repository, please visit [here](https://github.com/keploy/keploy/issues/new/choose) to submit Issue.
+> ⚠️ **Note:** Issue creation is disabled in this repository.  
+> To submit a new issue, please visit the [Keploy community forum](https://github.com/keploy/dashboard/issues) or the main repo’s issue tracker.
 
 <p align="center">
 <a href="https://github.com/keploy/docs" alt="GitHub contributors">
@@ -53,7 +54,7 @@ We use a variety of technologies to build the web interface and support the comm
 - [Yarn package manager](https://yarnpkg.com/)
 - [React](https://reactjs.org/)
 - [GitHub Actions](https://github.com/features/actions)
-- Docusaurus
+- [Docusaurus](https://docusaurus.io/)
 
 We use NodeJS and Yarn to install, test, and build the website. Docusaurus has been used as a static site generator to build the website. React is being utilized to build our custom component-based user interface to provide a modern look to the website. GitHub Actions manages our CI/CD pipelines and issue triage.
 
@@ -75,6 +76,8 @@ npm start
 
 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.

STYLE.md

@@ -1,50 +1,133 @@
-# Style guidance
+# Style Guidance
 
-In general, Keploy content follows the [Google developer documentation style guide](https://developers.google.com/style).
-When the Google guide is silent about an issue, we follow the [Microsoft Writing Style Guide](https://docs.microsoft.com/en-us/style-guide/welcome/).
+Keploy documentation generally follows the [Google Developer Documentation Style Guide](https://developers.google.com/style).
 
-## Keploy-specific style guidance
+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/).
 
-We have a few Keploy-specific style guidelines that override the Google and Microsoft guides.
+---
 
-### Capitalization of core terms
+## 🛠️ Keploy-Specific Style Guidelines
 
-Many of Keploy's core terms can be used in a generic way.
-To differentiate one of Keploy's core terms from a generic instance of a term, always treat the Keploy term as a proper noun in documentation.
-Generic versions of the same term should not be capitalized and should be used sparingly to avoid confusion.
+The following are Keploy-specific rules that override or expand on the Google and Microsoft guides.
 
-- Correct: "Next, Normalise the Test case on the Test run details."
-- Incorrect: "Next, normalise the test case on the test run details"
+---
 
-### En dashes in ranges
+### 📌 Capitalization of Core Terms
 
-Using an en dash (`–` or the character `–`) in a range of numbers is acceptable.
-Even better is to use words such as _from_, _to_, and _through_.
+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.
 
-Be consistent.
-If you use an en dash in one range, use en dashes in all ranges.
-Do not mix words and en dashes (or hyphens, for that matter).
+✅ **Correct:**
 
-- Correct: "5 to 10 GB"
-- Correct: "5–10 GB"
-- Correct: "5-10 GB"
-- Incorrect: "from 5-10 GB"
+> “Next, Normalise the Test case on the Test run details page.”
 
-## Headings
+❌ **Incorrect:**
 
-Although the following guidance is provided by both the Google and Microsoft guides, we want to emphasize how we style headings.
+> “Next, normalise the test case on the test run details.”
 
-### Infinitive verb forms in headings
+---
 
-Titles and headings should use infinitive verb forms whenever possible. People tend to search by using infinitive verb forms, so using them helps SEO.
+### 🔤 Sentence Case in Headings
 
-- Correct: "Install Keploy"
-- Incorrect: "Installing Keploy"
+Use **sentence case** for all titles and headings. This means only the **first word** and **proper nouns** are capitalized.
 
-### Sentence casing in headings
+✅ Correct:
 
-Use sentence casing for titles and headings.
-Sentence casing means that only the first letter of the first word and proper nouns are capitalized.
+> How to get started with Keploy
 
-- Correct: "How to get started with Keploy"
-- Incorrect: "How To Get Started With Keploy"
+❌ Incorrect:
+
+> How To Get Started With Keploy
+
+---
+
+### 🧾 Infinitive Verb Forms in Headings
+
+Use **infinitive verb forms** (e.g., "to install", "to create", "to configure") in titles and headings.  
+This improves searchability and aligns with common SEO practices.
+
+✅ Correct:
+
+> Install Keploy  
+> Create test cases
+
+❌ Incorrect:
+
+> Installing Keploy  
+> Creating test cases
+
+---
+
+### 🧮 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.
+
+✅ Correct:
+
+- 5–10 GB
+- 5 to 10 GB
+
+❌ Incorrect:
+
+- from 5-10 GB
+- 5–10 GB and 10 to 20 MB (mixed style)
+
+---
+
+### 🧠 Use Active Voice
+
+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.
+
+---
+
+### 🔧 Code Formatting
+
+- Wrap inline code using backticks: \`like this\`
+- Use triple backticks for multi-line code blocks:
+  \`\`\`bash  
+   npm install  
+   npm run serve  
+   \`\`\`
+- Add comments in code examples where needed for clarity.
+
+---
+
+## ✅ Summary Checklist for Writers
+
+- [ ] Are headings in sentence case and infinitive form?
+- [ ] Are core terms capitalized correctly?
+- [ ] Did I use active voice wherever possible?
+- [ ] Are numeric ranges formatted consistently?
+- [ ] Is my language clear and globally understandable?
+- [ ] Are code examples formatted properly?
+
+---
+
+> ✨ _Consistency leads to clarity. Let’s keep Keploy documentation clean, helpful, and easy to follow._

docusaurus.config.js

@@ -30,6 +30,17 @@ module.exports = {
       };
     },
     "docusaurus-tailwindcss-loader",
+    [
+      "@docusaurus/plugin-client-redirects",
+      {
+        redirects: [
+          {
+            to: "quickstart/sample-redis/",
+            from: ["/2.0.0/quickstart/samples-redis/"],
+          },
+        ],
+      },
+    ],
   ],
   themeConfig: {
     canonicalBase: "https://www.keploy.io/",
@@ -116,32 +127,45 @@ module.exports = {
       },
       items: [
         {
-          to: "/server/installation",
-          activeBasePath: "none",
-          label: "Installation",
+          label: "Products",
+          position: "left",
+          items: [
+            {
+              label: "Integration Testing",
+              to: "/keploy-explained/introduction",
+            },
+            {
+              label: "API Testing (AI)",
+              to: "/running-keploy/api-test-generator",
+            },
+            {
+              label: "Unit Testing",
+              to: "/running-keploy/utg-pr-agent",
+            },
+          ],
         },
-        // {
-        //   to: "/server/installation/",
-        //   label: "Installation",
-        // },
-        // {
-        //   to: "/docs/operation/web-ui-operations/",
-        //   activeBasePath: "(/docs/operation)",
-        //   label: "Operations",
-        // },
-        // {
-        //   to: "/docs/go/quickstart/run-your-first-app-tutorial/",
-        //   activeBaseRegex:
-        //     "(/application-development)|(/docs/(go|java|php|node))",
-        //   label: "test SDKs",
-        // },
         {
-          to: "/keploy-explained/contribution-guide",
-          label: "Contribution Guide",
+          label: "Blog",
+          items: [
+            {
+              label: "Tech Blogs",
+              href: "https://keploy.io/blog/technology",
+            },
+            {
+              label: "Community Articles",
+              href: "https://keploy.io/blog/community",
+            },
+            {
+              label: "Glossary",
+              href: "/concepts/reference/glossary/",
+            },
+          ],
+          position: "left",
         },
         {
-          to: "https://keploy.io/blog",
-          label: "Blog",
+          to: "/keploy-explained/contribution-guide",
+          label: "Contribution Guide",
+          position: "left",
         },
         {
           type: "docsVersionDropdown",
@@ -154,12 +178,6 @@ module.exports = {
           className: "header-github-link",
           "aria-label": "GitHub repository",
         },
-        // TODO : Add Blogging Section
-        // {
-        //   to: "/blog",
-        //   activeBasePath: "/blog",
-        //   label: "Blog",
-        // },
       ],
     },
     footer: {
@@ -220,15 +238,20 @@ module.exports = {
            * in `/docs/next` directory, only versioned docs.
            */
           // excludeNextVersionDocs: false,
-          lastVersion: "2.0.0",
+          lastVersion: "3.0.0",
           versions: {
             "1.0.0": {
               label: "1.0.0",
               path: "1.0.0",
               banner: "unmaintained",
             },
+            "2.0.0": {
+              label: "2.0.0",
+              path: "2.0.0",
+              banner: "unmaintained",
+            },
           },
-          onlyIncludeVersions: ["1.0.0", "2.0.0"],
+          onlyIncludeVersions: ["1.0.0", "2.0.0", "3.0.0"],
           includeCurrentVersion: true, // excludeNextVersionDocs is now deprecated
           // // below remark plugin disabled until we can figure out why it is not transpiling to ESNext properly - swyx
           remarkPlugins: [
@@ -309,6 +332,7 @@ module.exports = {
       },
     ],
   ],
+
   scripts: [
     {
       src: "/docs/scripts/feedback.js",

package.json

@@ -24,6 +24,8 @@
     "@docusaurus/plugin-sitemap": "^3.2.1",
     "@docusaurus/preset-classic": "^3.2.1",
     "@mdx-js/react": "^3.0.0",
+    "ajv": "^6.12.6",
+    "ajv-keywords": "^3.5.2",
     "clsx": "^2.0.0",
     "lint": "^0.8.19",
     "prism-react-renderer": "^2.1.0",
@@ -48,7 +50,7 @@
     ]
   },
   "devDependencies": {
-    "@docusaurus/plugin-client-redirects": "^3.2.1",
+    "@docusaurus/plugin-client-redirects": "^3.8.1",
     "@tailwindcss/typography": "^0.5.0",
     "autoprefixer": "^10.4.0",
     "docusaurus": "^1.14.7",