Skip to content

Commit 2b066db

Browse files
nehagupnehagup
committed
chore: added v3 structure of docs
Signed-off-by: Neha Gupta <[email protected]>
1 parent 5708825 commit 2b066db

32 files changed

+1948
-336
lines changed

‎docusaurus.config.js‎

Lines changed: 35 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -116,32 +116,45 @@ module.exports = {
116116
},
117117
items: [
118118
{
119-
to: "/server/installation",
120-
activeBasePath: "none",
121-
label: "Installation",
119+
label: "Products",
120+
position: "left",
121+
items: [
122+
{
123+
label: "Unit Testing",
124+
to: "/running-keploy/utg-pr-agent/",
125+
},
126+
{
127+
label: "Integration Testing",
128+
to: "/keploy-explained/introduction",
129+
},
130+
{
131+
label: "API Testing",
132+
to: "/running-keploy/about-api-testing",
133+
},
134+
],
122135
},
123-
// {
124-
// to: "/server/installation/",
125-
// label: "Installation",
126-
// },
127-
// {
128-
// to: "/docs/operation/web-ui-operations/",
129-
// activeBasePath: "(/docs/operation)",
130-
// label: "Operations",
131-
// },
132-
// {
133-
// to: "/docs/go/quickstart/run-your-first-app-tutorial/",
134-
// activeBaseRegex:
135-
// "(/application-development)|(/docs/(go|java|php|node))",
136-
// label: "test SDKs",
137-
// },
138136
{
139-
to: "/keploy-explained/contribution-guide",
140-
label: "Contribution Guide",
137+
label: "Blog",
138+
items: [
139+
{
140+
label: "Tech Blogs",
141+
href: "https://keploy.io/blog/technology",
142+
},
143+
{
144+
label: "Communtity Articles",
145+
href: "https://keploy.io/blog/community",
146+
},
147+
{
148+
label: "Glossary",
149+
href: "/concepts/reference/glossary/",
150+
},
151+
],
152+
position: "left",
141153
},
142154
{
143-
to: "https://keploy.io/blog",
144-
label: "Blog",
155+
to: "/keploy-explained/contribution-guide",
156+
label: "Contribution Guide",
157+
position: "left",
145158
},
146159
{
147160
type: "docsVersionDropdown",
@@ -154,12 +167,6 @@ module.exports = {
154167
className: "header-github-link",
155168
"aria-label": "GitHub repository",
156169
},
157-
// TODO : Add Blogging Section
158-
// {
159-
// to: "/blog",
160-
// activeBasePath: "/blog",
161-
// label: "Blog",
162-
// },
163170
],
164171
},
165172
footer: {

‎src/components/Product.js‎

Lines changed: 255 additions & 0 deletions
Large diffs are not rendered by default.

‎src/components/QuickStart.js‎

Lines changed: 30 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,12 @@ import useBaseUrl from "@docusaurus/useBaseUrl";
55
export const QuickStart = () => {
66
return (
77
<section className="mt-1">
8-
<h1 className="mb-4 text-4xl font-semibold tracking-wide md:text-5xl">
8+
<h1 className="mb-4 text-4xl font-semibold tracking-wide md:text-4xl">
99
Welcome to Keploy Documentation! 🚀
1010
</h1>
1111
<p className="text-l max-w-3xl">
12-
This documentation is your roadmap to becoming a Keploy expert, whether
13-
you're a seasoned developer or just starting out. 🗺️
12+
This documentation will help you get the most out of Keploy—whether
13+
you’re building your first project or leveling up your testing workflow.
1414
</p>
1515

1616
<h2 className="mb-4 mt-8 text-2xl font-semibold tracking-wide md:text-3xl">
@@ -19,37 +19,40 @@ export const QuickStart = () => {
1919
<p className="text-l max-w-4xl">
2020
Keploy is your open-source, developer-centric backend testing tool. It
2121
makes backend testing easy and productive for engineering teams. Plus,
22-
it's easy-to-use, powerful and extensible..🛠️
22+
it's easy-to-use, powerful and extensible..🛠️ Keploy also has AI-powered
23+
tools that help you generate unit and api tests quickly, helping
24+
developers focus on writing code rather than writing tests.
2325
</p>
26+
2427
<p className="text-l mt-4 max-w-4xl">
2528
Keploy creates test cases and data mocks/stubs from user-traffic by
2629
recording API calls and DB queries, significantly speeding up releases
2730
and enhancing reliability. 📈
2831
</p>
2932

30-
<h2 className="mt-8 text-2xl font-semibold tracking-wide md:text-3xl">
31-
Contribute through Hacktoberfest ✅
32-
</h2>
33-
<p className="text-l mb-8 mt-4 max-w-4xl">
34-
DigitalOcean's Hacktoberfest is a month-long celebration of open-source
35-
contributions. Everyone is welcome to participate, regardless of their
36-
experience level. Simply make a pull request to an open-source project
37-
to get started.
38-
<br /> <br />
39-
You can contribute to{" "}
40-
<a href="https://github.com/orgs/keploy/repositories">
41-
several Keploy projects
42-
</a>{" "}
43-
participating this year, If you’ve ever wanted to contribute to open
44-
source , now is your chance!
45-
<br /> <br />
46-
Anyone around the globe who desires to help drive the growth of open
47-
source and make positive contributions to an ever-growing community. All
48-
backgrounds and skill levels are encouraged to participate.{" "}
49-
<a href="https://opensource.guide/how-to-contribute">
50-
Learn How to Contribute?
51-
</a>
52-
</p>
33+
{/*<h2 className="mt-8 text-2xl font-semibold tracking-wide md:text-3xl">*/}
34+
{/* Contribute through Hacktoberfest ✅*/}
35+
{/*</h2>*/}
36+
{/*<p className="text-l mb-8 mt-4 max-w-4xl">*/}
37+
{/* DigitalOcean's Hacktoberfest is a month-long celebration of open-source*/}
38+
{/* contributions. Everyone is welcome to participate, regardless of their*/}
39+
{/* experience level. Simply make a pull request to an open-source project*/}
40+
{/* to get started.*/}
41+
{/* <br /> <br />*/}
42+
{/* You can contribute to{" "}*/}
43+
{/* <a href="https://github.com/orgs/keploy/repositories">*/}
44+
{/* several Keploy projects*/}
45+
{/* </a>{" "}*/}
46+
{/* participating this year, If you’ve ever wanted to contribute to open*/}
47+
{/* source , now is your chance!*/}
48+
{/* <br /> <br />*/}
49+
{/* Anyone around the globe who desires to help drive the growth of open*/}
50+
{/* source and make positive contributions to an ever-growing community. All*/}
51+
{/* backgrounds and skill levels are encouraged to participate.{" "}*/}
52+
{/* <a href="https://opensource.guide/how-to-contribute">*/}
53+
{/* Learn How to Contribute?*/}
54+
{/* </a>*/}
55+
{/*</p>*/}
5356

5457
<h2 className="mt-8 text-2xl font-semibold tracking-wide md:text-3xl">
5558
Installation Guide 📗

‎src/components/UtgMethods.js‎

Lines changed: 147 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,147 @@
1+
import React from "react";
2+
import Link from "@docusaurus/Link";
3+
import useBaseUrl from "@docusaurus/useBaseUrl";
4+
5+
function UTGMethods() {
6+
return (
7+
<div className="mb-8 rounded-lg">
8+
<h2 className="mb-6 text-2xl font-semibold tracking-wide md:text-3xl">
9+
Three Ways to Generate Unit Tests 🚀
10+
</h2>
11+
<p className="mb-6 max-w-4xl text-lg">
12+
Choose the method that best fits your workflow - from automated PR
13+
integration to one-click IDE generation:
14+
</p>
15+
16+
<ul className="grid auto-cols-[300px] grid-flow-col gap-3 lg:gap-5">
17+
<li className="mt-5 flex flex-col space-y-3 text-lg">
18+
<Link
19+
className="text-foreground-light flex-grow text-sm"
20+
to={useBaseUrl(
21+
"/running-keploy/unit-test-generator/#1-pr-agent-latest-"
22+
)}
23+
>
24+
<div className="rounded-lg bg-[color:var(--ifm-card-background-color)] p-5 shadow transition hover:shadow-lg hover:shadow-[color:var(--ifm-card-shadow-color)]">
25+
<div className="flex items-center space-x-4">
26+
<svg
27+
xmlns="http://www.w3.org/2000/svg"
28+
className="mb-4 h-10 w-10 rounded-lg bg-[color:var(--ifm-color)] p-2 text-[color:var(--ifm-background-color)]"
29+
viewBox="0 0 24 24"
30+
width="24"
31+
height="24"
32+
fill="none"
33+
stroke="currentColor"
34+
strokeWidth="2"
35+
strokeLinecap="round"
36+
strokeLinejoin="round"
37+
>
38+
<path d="M16 22h2a2 2 0 0 0 2-2V7l-5-5H6a2 2 0 0 0-2 2v3" />
39+
<path d="M14 2v4a2 2 0 0 0 2 2h4" />
40+
<circle cx="8" cy="16" r="6" />
41+
<path d="m6 18 1.5-1.5L9 18l1.5-1.5" />
42+
</svg>
43+
<h2 className="mb-4 text-xl font-semibold">
44+
PR Agent (Latest)
45+
</h2>
46+
</div>
47+
<ul>
48+
<li>
49+
<p className="font">
50+
Automatically generates unit tests when you create pull
51+
requests. Install once, get tests for every PR with changed
52+
files.
53+
</p>
54+
</li>
55+
</ul>
56+
</div>
57+
</Link>
58+
</li>
59+
60+
<li className="mt-5 flex flex-col space-y-3 text-lg">
61+
<Link
62+
className="text-foreground-light flex-grow text-sm"
63+
to={useBaseUrl(
64+
"/running-keploy/unit-test-generator/#2-vs-code-extension-"
65+
)}
66+
>
67+
<div className="rounded-lg bg-[color:var(--ifm-card-background-color)] p-5 shadow transition hover:shadow-lg hover:shadow-[color:var(--ifm-card-shadow-color)]">
68+
<div className="flex items-center space-x-4">
69+
<svg
70+
xmlns="http://www.w3.org/2000/svg"
71+
className="mb-4 h-10 w-10 rounded-lg bg-[color:var(--ifm-color)] p-2 text-[color:var(--ifm-background-color)]"
72+
viewBox="0 0 24 24"
73+
width="24"
74+
height="24"
75+
fill="none"
76+
stroke="currentColor"
77+
strokeWidth="2"
78+
strokeLinecap="round"
79+
strokeLinejoin="round"
80+
>
81+
<rect width="18" height="18" x="3" y="3" rx="2" />
82+
<path d="M9 8l3 3-3 3" />
83+
<path d="m16 16-5 0" />
84+
</svg>
85+
<h2 className="mb-4 text-xl font-semibold">
86+
VS Code Extension
87+
</h2>
88+
</div>
89+
<ul>
90+
<li>
91+
<p className="font">
92+
One-click unit test generation directly in VS Code. Install
93+
the extension and generate tests for your entire project
94+
instantly.
95+
</p>
96+
</li>
97+
</ul>
98+
</div>
99+
</Link>
100+
</li>
101+
102+
<li className="mt-5 flex flex-col space-y-3 text-lg">
103+
<Link
104+
className="text-foreground-light flex-grow text-sm"
105+
to={useBaseUrl(
106+
"/running-keploy/unit-test-generator/#3-command-line-interface-"
107+
)}
108+
>
109+
<div className="rounded-lg bg-[color:var(--ifm-card-background-color)] p-5 shadow transition hover:shadow-lg hover:shadow-[color:var(--ifm-card-shadow-color)]">
110+
<div className="flex items-center space-x-4">
111+
<svg
112+
xmlns="http://www.w3.org/2000/svg"
113+
className="mb-4 h-10 w-10 rounded-lg bg-[color:var(--ifm-color)] p-2 text-[color:var(--ifm-background-color)]"
114+
viewBox="0 0 24 24"
115+
width="24"
116+
height="24"
117+
fill="none"
118+
stroke="currentColor"
119+
strokeWidth="2"
120+
strokeLinecap="round"
121+
strokeLinejoin="round"
122+
>
123+
<polyline points="4 17 10 11 4 5" />
124+
<line x1="12" x2="20" y1="19" y2="19" />
125+
</svg>
126+
<h2 className="mb-4 text-xl font-semibold">
127+
Command Line Interface
128+
</h2>
129+
</div>
130+
<ul>
131+
<li>
132+
<p className="font">
133+
Traditional CLI approach with full control over test
134+
generation. Perfect for CI/CD pipelines and automated
135+
workflows.
136+
</p>
137+
</li>
138+
</ul>
139+
</div>
140+
</Link>
141+
</li>
142+
</ul>
143+
</div>
144+
);
145+
}
146+
147+
export default UTGMethods;

‎src/css/custom.css‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -223,11 +223,11 @@ div[class^="sidebar_"] .button svg {
223223

224224
/* Navbar */
225225
.navbar__inner {
226-
@apply mx-auto max-w-screen-lg shadow-none lg:px-10;
226+
@apply mx-auto w-full max-w-none px-4 shadow-none lg:px-10;
227227
}
228228

229229
.navbar__items--right {
230-
@apply flex-row-reverse;
230+
@apply justify-end ml-auto flex-row-reverse;
231231
}
232232

233233
.navbar__items--right > :last-child {

‎src/pages/index.js‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ import React from "react";
22
import Layout from "@theme/Layout";
33
import useDocusaurusContext from "@docusaurus/useDocusaurusContext";
44
import {Community, KeployCloud, Resources, QuickStart} from "../components";
5-
import {GSoC} from "../components/GSoC";
5+
import {Products} from "../components/Product";
66
import {Intro} from "../components";
77
export default function Home() {
88
const context = useDocusaurusContext();
@@ -19,6 +19,7 @@ export default function Home() {
1919
{/* <Hacktoberfest /> */}
2020
{/*<GitTogether />*/}
2121
<Intro />
22+
<Products />
2223
<Resources />
2324
<Community />
2425
{/*<GSoC/>*/}

‎versioned_docs/version-3.0.0/keploy-explained/ai-models.md‎

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
---
2+
id: ai-models
3+
title: How Keploy Uses AI Models for Testing
4+
sidebar_label: How Keploy Uses AI Models for Testing
5+
description: How Keploy leverages state-of-the-art AI models for next-generation testing automation.
6+
tags:
7+
- AI
8+
- LLM
9+
- unit testing
10+
- Gemini
11+
- GPT-4
12+
---
13+
14+
# 🤖 AI Models at Keploy
15+
16+
Keploy is a vertical testing agent, built to generate high-quality unit tests using the world’s best AI.
17+
18+
We don’t just rely on one model—we harness the strengths of multiple cutting-edge LLMs to give you smarter, more accurate, and more relevant tests.
19+
20+
## 🚀 Multi-Model, Multi-Benefit
21+
22+
- **Gemini 2.5 Pro (Google):** Advanced reasoning, code understanding, and context awareness.
23+
- **GPT-4 Family (OpenAI):** Exceptional language ability, coverage of edge cases, and broad code knowledge.
24+
- **Other Specialized Models:** We continuously evaluate and integrate new AI models to keep raising the bar for testing automation.
25+
26+
By combining different models, Keploy can generate better test cases, filter out weak tests, and cover more scenarios.
27+
28+
## 🏗️ How It Works
29+
30+
- **Best of All Worlds:** For each test file, Keploy routes tasks to different models—letting each one play to its strengths.
31+
- **Quality Over Quantity:** Results are validated and cross-checked, so you get fewer, but stronger and more useful tests.
32+
- **Rapid Updates:** As AI models evolve, Keploy upgrades seamlessly—always keeping you on the leading edge.
33+
34+
## 🌐 Transparency & User Trust
35+
36+
- **No Code Used for Training:** Your code and test data are **never** used to train any external AI model.
37+
38+
- **Model Selection:** We choose models for you automatically, but always with a focus on security, reliability, and test quality.
39+
40+
Want to learn more about how AI powers Keploy? [Contact us](mailto:[email protected])

0 commit comments

Comments
 (0)