Skip to content

Commit aacca9f

Browse files
committed
feat: revamp docs
Signed-off-by: Animesh Pathak <[email protected]>
1 parent 533988e commit aacca9f

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

66 files changed

+950
-356
lines changed

docusaurus.config.js

+18-5
Original file line numberDiff line numberDiff line change
@@ -118,7 +118,7 @@ module.exports = {
118118
{
119119
to: "/server/installation",
120120
activeBasePath: "none",
121-
label: "Installation",
121+
label: "Start",
122122
},
123123
// {
124124
// to: "/server/installation/",
@@ -136,12 +136,25 @@ module.exports = {
136136
// label: "test SDKs",
137137
// },
138138
{
139-
to: "/keploy-explained/contribution-guide",
140-
label: "Contribution Guide",
139+
to: "/keploy-cloud/cloud-installation",
140+
label: "Cloud",
141141
},
142142
{
143-
to: "https://keploy.io/blog",
144-
label: "Blog",
143+
label: "Resources",
144+
items: [
145+
{
146+
label: 'Blogs',
147+
href:'https://keploy.io/blog',
148+
},
149+
{
150+
label: 'Contributing',
151+
href: '/keploy-explained/contribution-guide',
152+
},
153+
{
154+
label: 'FAQ',
155+
href:'/keploy-explained/faq/',
156+
},
157+
]
145158
},
146159
{
147160
type: "docsVersionDropdown",

src/components/GitTogether.js renamed to src/components/DevScribe.js

+5-5
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,13 @@ export const GitTogether = () => {
44
return (
55
<section className="mb-14 mt-1">
66
<h2 className="mt-8 text-2xl font-semibold tracking-wide md:text-3xl">
7-
Attend GitTogether
7+
Attend DevScribe
88
</h2>
9-
<a href="https://keploy.io/gittogether">
9+
<a href="https://keploy.io/devscribe">
1010
<img
11-
className="mt-8 "
12-
src="/docs/img/GitTogether.jpg"
13-
alt={"GitTogether Image"}
11+
className="mt-8"
12+
src="/docs/img/Devscribe.png"
13+
alt={"DevScribe Image"}
1414
/>
1515
</a>
1616
<div className="mt-8 grid grid-cols-1 gap-5 md:grid-cols-2">

src/components/Intro.js

+7-3
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ function Languages() {
2727
fill="currentColor"
2828
/>
2929
</svg>
30-
<h2 className="mb-4 text-xl font-semibold">Languages</h2>
30+
<h2 className="mb-4 text-xl font-semibold">QuickStart</h2>
3131
</div>
3232
<ul className="grid grid-cols-3 gap-3 md:grid-cols-3 lg:gap-5">
3333
{/* <ul className="grid grid-cols-2 gap-6 xl:gap-8"> */}
@@ -227,9 +227,13 @@ export const Intro = () => {
227227
return (
228228
<section className="mb-4 mt-12">
229229
<h2 className="mb-4 text-2xl font-semibold tracking-wide md:text-3xl">
230-
Supports
230+
Getting Started ✨
231231
</h2>
232-
<div className="grid gap-6 sm:grid-cols-2 xl:gap-8">
232+
<p className="text-l text-gray-500">
233+
Get up and running with Keploy in just a few minutes by integrating it with your applications.
234+
Below are the quick-start guides for popular languages and frameworks.
235+
</p><br/>
236+
<div className="grid gap-6 sm:grid-cols-2 xl:gap-8">
233237
<Languages />
234238
<Frameworks />
235239
</div>

src/components/Product.js

+134
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

src/components/QuickStart.js

+14-45
Original file line numberDiff line numberDiff line change
@@ -6,57 +6,28 @@ export const QuickStart = () => {
66
return (
77
<section className="mt-1">
88
<h1 className="mb-4 text-4xl font-semibold tracking-wide md:text-5xl">
9-
Welcome to Keploy Documentation! 🚀
9+
Keploy Documentation! 🚀
1010
</h1>
11-
<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. 🗺️
11+
<p className="text-l max-w-3xxl">
12+
Welcome to Keploy’s documentation! Whether you're new to backend testing or an experienced developer, this guide will help you get started with Keploy quickly and effectively.🗺️
1413
</p>
1514

1615
<h2 className="mb-4 mt-8 text-2xl font-semibold tracking-wide md:text-3xl">
1716
What is Keploy? 🤔
1817
</h2>
19-
<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..🛠️
23-
</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-
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>
18+
<p className="text-l max-w-3xxl">
19+
Keploy is an open-source backend testing tool that helps developers quickly create and run tests by capturing
20+
real user traffic. It generates test cases and data mocks to ensure your code is reliable and helps speed up your release cycle..🛠️
21+
<br/><br/>
22+
With features like API testing, unit test generation, and schema/PRD-based test automation, Keploy helps teams release faster while maintaining high reliability.
23+
It’s easy to use, extensible, and integrates seamlessly into CI/CD pipelines, making backend testing efficient and productive.
5224
</p>
5325

5426
<h2 className="mt-8 text-2xl font-semibold tracking-wide md:text-3xl">
55-
Installation Guide 📗
27+
Setup Guide 📗
5628
</h2>
5729
<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. ⏱️
30+
Follow the steps below to install Keploy on your system. ⏱️
6031
</p>
6132

6233
<div className="grid grid-cols-1 gap-6 md:grid-cols-3 lg:gap-8">
@@ -89,15 +60,13 @@ export const QuickStart = () => {
8960
<img
9061
className="h-16 w-16"
9162
src="/docs/img/os/apple-logo.svg"
92-
alt="Mac logo"
63+
alt="MacOs logo"
9364
/>
9465
<p className="text-lg font-semibold">MacOS</p>
9566
</Link>
9667
</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.
68+
<p className="text-l mt-6 text-gray-500">
69+
<b>⚠️ Important Note:</b> Keploy v2 is currently in Beta, and the best experience is on Linux. Docker support is experimental, and some limitations may apply.
10170
</p>
10271
</section>
10372
);

src/components/SDKs.js

+2-13
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ export const SDKs = () => {
2020
src="/docs/img/os/windows-logo.svg"
2121
alt="Windows logo"
2222
/>
23-
<p className="text-lg">Windows</p>
23+
<p className="text-lg">Native</p>
2424
</Link>
2525
<Link
2626
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"
@@ -31,18 +31,7 @@ export const SDKs = () => {
3131
src="/docs/img/os/linux-logo.svg"
3232
alt="Linux logo"
3333
/>
34-
<p className="text-lg">Linux</p>
35-
</Link>
36-
<Link
37-
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"
38-
to={useBaseUrl("/server/installation")}
39-
>
40-
<img
41-
className="h-16 w-16"
42-
src="/docs/img/os/apple-logo.svg"
43-
alt="Mac logo"
44-
/>
45-
<p className="text-lg">MacOS</p>
34+
<p className="text-lg">Docker</p>
4635
</Link>
4736
</div>
4837
</section>

src/pages/index.js

+4-5
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,8 @@ 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 {GitTogether} from "../components/DevScribe";
6+
import {Products} from "../components/Product";
67
import {Intro} from "../components";
78
export default function Home() {
89
const context = useDocusaurusContext();
@@ -16,12 +17,10 @@ export default function Home() {
1617
>
1718
<main className="mx-auto max-w-screen-lg p-6 md:p-10">
1819
<QuickStart />
19-
{/* <Hacktoberfest /> */}
20-
{/*<GitTogether />*/}
20+
{/* <GitTogether /> */}
2121
<Intro />
22-
<Resources />
22+
<Products />
2323
<Community />
24-
{/*<GSoC/>*/}
2524
<KeployCloud />
2625
</main>
2726
</Layout>

static/img/DevScribe.png

41.6 KB
Loading

static/img/api.svg

+9
Loading

versioned_docs/version-2.0.0/ci-cd/github.md

+4
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,10 @@ tags:
1313
- cd
1414
- plugin
1515
---
16+
<head>
17+
<title>Integrating with GitHub CI | Keploy Docs</title>
18+
<meta charSet="utf-8" />
19+
</head>
1620

1721
Keploy can be integrated with GitHub by two methods:-
1822

versioned_docs/version-2.0.0/ci-cd/gitlab.md

+4
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,10 @@ tags:
1313
- cd
1414
- plugin
1515
---
16+
<head>
17+
<title>Integrating with GitLab CI | Keploy Docs</title>
18+
<meta charSet="utf-8" />
19+
</head>
1620

1721
Keploy can integrated with GitLab CI to streamline your testing process and ensure continuous testing as part of your CI/CD pipeline.
1822

0 commit comments

Comments
 (0)