Skip to content

Commit 95e0fa6

Browse files
Achanandhi-Mamaan-bhatiTvisha Rajinehagup
authored
feat: Added new docs structure (#521)
* feat: Added New docs structure Signed-off-by: Achanandhi-M <achanandhi.m@gmail.com> * feat: add content for the utg-pr agent Signed-off-by: amaan-bhati <amaanbhati49@gmail.com> * chore: test commit/remove utg cli Signed-off-by: amaan-bhati <amaanbhati49@gmail.com> * feat: add/edit instructions and added them all to the sidebar Signed-off-by: amaan-bhati <amaanbhati49@gmail.com> * API testing * feat: trim down content, update pr agent link Signed-off-by: amaan-bhati <amaanbhati49@gmail.com> * add: revamp unit and api docs page Signed-off-by: Achanandhi-M <achanandhi.m@gmail.com> --------- Signed-off-by: Achanandhi-M <achanandhi.m@gmail.com> Signed-off-by: amaan-bhati <amaanbhati49@gmail.com> Co-authored-by: amaan-bhati <amaanbhati49@gmail.com> Co-authored-by: Amaan Bhati <94218318+amaan-bhati@users.noreply.github.com> Co-authored-by: Tvisha Raji <tvisharaji@Tvishas-MacBook-Air.local> Co-authored-by: Neha Gupta <gneha21@yahoo.in>
1 parent c747f02 commit 95e0fa6

32 files changed

+2072
-385
lines changed

‎docusaurus.config.js‎

Lines changed: 36 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -116,9 +116,21 @@ module.exports = {
116116
},
117117
items: [
118118
{
119-
to: "/server/installation",
120-
activeBasePath: "none",
121-
label: "Installation",
119+
label: "Products",
120+
items: [
121+
{
122+
label: "Unit Testing",
123+
href: "/running-keploy/unit-test-generator",
124+
},
125+
{
126+
label: "Integration Testing",
127+
href: "/keploy-explained/introduction",
128+
},
129+
{
130+
label: "API Testing",
131+
href: "/running-keploy/api-test-generator",
132+
},
133+
],
122134
},
123135
// {
124136
// to: "/server/installation/",
@@ -138,10 +150,24 @@ module.exports = {
138150
{
139151
to: "/keploy-explained/contribution-guide",
140152
label: "Contribution Guide",
153+
activeBasePath: "none",
141154
},
142155
{
143-
to: "https://keploy.io/blog",
144-
label: "Blog",
156+
label: "Resources",
157+
items: [
158+
{
159+
label: "Tech Blogs",
160+
href: "https://keploy.io/blog/technology",
161+
},
162+
{
163+
label: "Communtity Articles",
164+
href: "https://keploy.io/blog/community",
165+
},
166+
{
167+
label: "Glossary",
168+
href: "/concepts/reference/glossary/",
169+
},
170+
],
145171
},
146172
{
147173
type: "docsVersionDropdown",
@@ -154,6 +180,11 @@ module.exports = {
154180
className: "header-github-link",
155181
"aria-label": "GitHub repository",
156182
},
183+
{
184+
href: "https://app.keploy.io/pricing",
185+
position: "right",
186+
label: "Pricing",
187+
},
157188
// TODO : Add Blogging Section
158189
// {
159190
// to: "/blog",

‎src/components/Product.js‎

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

‎src/components/QuickStart.js‎

Lines changed: 10 additions & 61 deletions
Original file line numberDiff line numberDiff line change
@@ -5,28 +5,25 @@ 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.
14+
🗺️
1415
</p>
1516

1617
<h2 className="mb-4 mt-8 text-2xl font-semibold tracking-wide md:text-3xl">
1718
What is Keploy? 🤔
1819
</h2>
1920
<p className="text-l max-w-4xl">
20-
Keploy is your open-source, developer-centric backend testing tool. It
21-
makes backend testing easy and productive for engineering teams. Plus,
22-
it's easy-to-use, powerful and extensible..🛠️
21+
Keploy is an AI-powered tool that generates test cases and mocks/stubs
22+
for unit, integration, and API testing, helping developers achieve 90%
23+
test coverage in minutes. With open-source automation and enhanced test
24+
reliability, Keploy simplifies testing workflows.
2325
</p>
24-
<p className="text-l mt-4 max-w-4xl">
25-
Keploy creates test cases and data mocks/stubs from user-traffic by
26-
recording API calls and DB queries, significantly speeding up releases
27-
and enhancing reliability. 📈
28-
</p>
29-
26+
{/*
3027
<h2 className="mt-8 text-2xl font-semibold tracking-wide md:text-3xl">
3128
Contribute through Hacktoberfest ✅
3229
</h2>
@@ -50,55 +47,7 @@ export const QuickStart = () => {
5047
Learn How to Contribute?
5148
</a>
5249
</p>
53-
54-
<h2 className="mt-8 text-2xl font-semibold tracking-wide md:text-3xl">
55-
Installation Guide 📗
56-
</h2>
57-
<p className="text-l mb-8 mt-4 max-w-4xl">
58-
Let's get Keploy up and running on your Windows, Linux, or macOS
59-
machine, so you can start crafting test cases in minutes. ⏱️
60-
</p>
61-
62-
<div className="grid grid-cols-1 gap-6 md:grid-cols-3 lg:gap-8">
63-
<Link
64-
className="scale flex flex-col items-center justify-center space-y-3 rounded-lg bg-[color:var(--ifm-card-background-color)] p-6 text-center shadow-lg"
65-
to={useBaseUrl("/server/installation/")}
66-
>
67-
<img
68-
className="h-16 w-16"
69-
src="/docs/img/os/windows-logo.svg"
70-
alt="Windows logo"
71-
/>
72-
<p className="text-lg font-semibold">Windows</p>
73-
</Link>
74-
<Link
75-
className="scale flex flex-col items-center justify-center space-y-3 rounded-lg bg-[color:var(--ifm-card-background-color)] p-6 text-center shadow-lg"
76-
to={useBaseUrl("/server/installation/")}
77-
>
78-
<img
79-
className="h-16 w-16"
80-
src="/docs/img/os/linux-logo.svg"
81-
alt="Linux logo"
82-
/>
83-
<p className="text-lg font-semibold">Linux</p>
84-
</Link>
85-
<Link
86-
className="scale flex flex-col items-center justify-center space-y-3 rounded-lg bg-[color:var(--ifm-card-background-color)] p-6 text-center shadow-lg"
87-
to={useBaseUrl("/server/installation/")}
88-
>
89-
<img
90-
className="h-16 w-16"
91-
src="/docs/img/os/apple-logo.svg"
92-
alt="Mac logo"
93-
/>
94-
<p className="text-lg font-semibold">MacOS</p>
95-
</Link>
96-
</div>
97-
<p className=" text-l mt-6 text-gray-500">
98-
⚠️ Please note that Keploy v2 is currently in development, with the best
99-
experience on Linux. Docker support is experimental and may have some
100-
limitations for certain use cases.
101-
</p>
50+
*/}
10251
</section>
10352
);
10453
};

‎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 & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -223,21 +223,16 @@ 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 {
234234
@apply pr-5;
235235
}
236-
237-
.navbar__brand {
238-
@apply mb-3;
239-
}
240-
241236
/* Search */
242237

243238
.DocSearch-Button {

‎src/pages/index.js‎

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,8 @@ import Layout from "@theme/Layout";
33
import useDocusaurusContext from "@docusaurus/useDocusaurusContext";
44
import {Community, KeployCloud, Resources, QuickStart} from "../components";
55
import {GSoC} from "../components/GSoC";
6-
import {Intro} from "../components";
6+
import {Products} from "../components/Product";
7+
/*import {Intro} from "../components";*/
78
export default function Home() {
89
const context = useDocusaurusContext();
910
const {siteConfig = {}} = context;
@@ -18,8 +19,9 @@ export default function Home() {
1819
<QuickStart />
1920
{/* <Hacktoberfest /> */}
2021
{/*<GitTogether />*/}
21-
<Intro />
22-
<Resources />
22+
{<Products />}
23+
{/*<Intro />*/}
24+
{/* <Resources />*/}
2325
<Community />
2426
{/*<GSoC/>*/}
2527
<KeployCloud />

‎static/img/utg-installation/utg-banner.png‎

431 KB
Loading

‎static/img/utg-installation/vsc-ext-1.png‎

674 KB
Loading

‎static/img/utg-installation/vsc-ext-3.png‎

613 KB
Loading

‎versioned_docs/version-2.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:support@keploy.io)

0 commit comments

Comments
 (0)