Skip to content

Commit dc76a67

Browse files
chore: ui and versional changes
Signed-off-by: Atishay Tripathi <atishay1922@gmail.com>
1 parent d7a5b40 commit dc76a67

File tree

259 files changed

+1812
-18631
lines changed

Some content is hidden

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

259 files changed

+1812
-18631
lines changed

docusaurus.config.js

Lines changed: 12 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,7 @@
1-
//@ts-check
1+
// @ts-nocheck
22

3-
import {themes as prismThemes} from "prism-react-renderer";
4-
const path = require("path");
5-
import {visit} from "unist-util-visit";
3+
const { themes: prismThemes } = require("prism-react-renderer");
4+
const visit = require("unist-util-visit");
65
const FontPreloadPlugin = require("webpack-font-preload-plugin");
76

87
/** @type {import('@docusaurus/types').DocusaurusConfig} */
@@ -50,7 +49,7 @@ module.exports = {
5049
content:
5150
"API testing, Keploy docs, incident replay, network calls, code paths, test scenarios, code coverage, stubs, junit, go-test, live environment, production incidents, open source, regression tests, ai tests",
5251
},
53-
{name: "twitter:card", content: "summary_large_image"},
52+
{ name: "twitter:card", content: "summary_large_image" },
5453
],
5554
headTags: [
5655
// Preconnect tag
@@ -259,7 +258,7 @@ module.exports = {
259258
* in `/docs/next` directory, only versioned docs.
260259
*/
261260
// excludeNextVersionDocs: false,
262-
lastVersion: "4.0.0",
261+
lastVersion: "3.0.0",
263262
versions: {
264263
"1.0.0": {
265264
label: "1.0.0",
@@ -271,13 +270,8 @@ module.exports = {
271270
path: "2.0.0",
272271
banner: "unmaintained",
273272
},
274-
"3.0.0": {
275-
label: "3.0.0",
276-
path: "3.0.0",
277-
banner: "unmaintained",
278-
},
279273
},
280-
onlyIncludeVersions: ["1.0.0", "2.0.0", "3.0.0", "4.0.0"],
274+
onlyIncludeVersions: ["1.0.0", "2.0.0", "3.0.0"],
281275
includeCurrentVersion: true, // excludeNextVersionDocs is now deprecated
282276
// // below remark plugin disabled until we can figure out why it is not transpiling to ESNext properly - swyx
283277
remarkPlugins: [
@@ -343,11 +337,12 @@ module.exports = {
343337
theme: {
344338
customCss: require.resolve("./src/css/custom.css"),
345339
},
346-
gtag: {
347-
trackingID: "G-LLS95VWZPC",
348-
// Optional fields.
349-
anonymizeIP: true, // Should IPs be anonymized?
350-
},
340+
// Temporarily disabled gtag due to "window.gtag is not a function" error
341+
// gtag: {
342+
// trackingID: "G-LLS95VWZPC",
343+
// // Optional fields.
344+
// anonymizeIP: true, // Should IPs be anonymized?
345+
// },
351346
// Will be passed to @docusaurus/plugin-content-sitemap
352347
sitemap: {
353348
// Per v2.0.0-alpha.72 cacheTime is now deprecated

package.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,7 @@
3838
"react-player": "^2.6.0",
3939
"remark-typescript-tools": "1.0.9",
4040
"typescript": "5",
41+
"unist-util-visit": "^2.0.3",
4142
"uuid": "^8.3.2",
4243
"webpack-font-preload-plugin": "^1.5.0"
4344
},

sidebars.js

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
/**
2+
* Creating a sidebar enables you to:
3+
- create an ordered group of docs
4+
- render a sidebar for each doc of that group
5+
- provide next/previous navigation
6+
7+
The sidebars can be generated from the filesystem, or explicitly defined here.
8+
9+
Create as many sidebars as you want.
10+
*/
11+
12+
// @ts-check
13+
14+
/** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */
15+
const sidebars = {
16+
// By default, Docusaurus generates a sidebar from the docs folder structure
17+
// tutorialSidebar: [{type: 'autogenerated', dirName: '.'}],
18+
19+
// But you can create a sidebar manually
20+
/*
21+
tutorialSidebar: [
22+
'intro',
23+
'hello',
24+
{
25+
type: 'category',
26+
label: 'Tutorial',
27+
items: ['tutorial-basics/create-a-document'],
28+
},
29+
],
30+
*/
31+
};
32+
33+
module.exports = sidebars;

src/css/custom.css

Lines changed: 205 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2721,3 +2721,208 @@ html[data-theme="dark"] div[class^="sidebar_"] > nav > ul > li > .menu__list-ite
27212721
line-height: 1.4;
27222722
}
27232723
}
2724+
2725+
/* ===== CONSISTENT SPACING FOR DOCUMENTATION PAGES ===== */
2726+
/* Fix inconsistent vertical spacing in documentation content */
2727+
article header + * {
2728+
margin-top: 2rem !important; /* Consistent space after page title */
2729+
}
2730+
2731+
article h1 {
2732+
margin-bottom: 1.5rem !important; /* Consistent space after H1 */
2733+
}
2734+
2735+
article h2 {
2736+
margin-top: 2.5rem !important; /* Consistent space before H2 */
2737+
margin-bottom: 1rem !important; /* Consistent space after H2 */
2738+
}
2739+
2740+
article h3 {
2741+
margin-top: 2rem !important; /* Consistent space before H3 */
2742+
margin-bottom: 0.75rem !important; /* Consistent space after H3 */
2743+
}
2744+
2745+
article p {
2746+
margin-bottom: 1rem !important; /* Consistent space after paragraphs */
2747+
}
2748+
2749+
article img {
2750+
margin-top: 1.5rem !important; /* Consistent space before images */
2751+
margin-bottom: 1.5rem !important; /* Consistent space after images */
2752+
}
2753+
2754+
article \u003e div[style*='backgroundColor'] {
2755+
margin-top: 1.5rem !important; /* Consistent space before styled divs */
2756+
margin-bottom: 1.5rem !important; /* Consistent space after styled divs */
2757+
}
2758+
2759+
2760+
/* Override Tailwind prose spacing for better consistency */
2761+
.prose.md\\:prose-md {
2762+
margin-top: 1.5rem !important;
2763+
margin-bottom: 1.5rem !important;
2764+
}
2765+
2766+
/* More specific overrides for prose elements */
2767+
.prose p {
2768+
margin-top: 1rem !important;
2769+
margin-bottom: 1rem !important;
2770+
}
2771+
2772+
.prose h1 {
2773+
margin-top: 0 !important;
2774+
margin-bottom: 1.5rem !important;
2775+
}
2776+
2777+
.prose h2 {
2778+
margin-top: 2rem !important;
2779+
margin-bottom: 1rem !important;
2780+
}
2781+
2782+
.prose h3 {
2783+
margin-top: 1.5rem !important;
2784+
margin-bottom: 0.75rem !important;
2785+
}
2786+
2787+
.prose img {
2788+
margin-top: 1.5rem !important;
2789+
margin-bottom: 1.5rem !important;
2790+
}
2791+
2792+
/* Fix the large top margin on first element after header */
2793+
.markdown \u003e *:first-child,
2794+
article \u003e .markdown \u003e *:first-child {
2795+
margin-top: 1.5rem !important;
2796+
}
2797+
2798+
2799+
/* Fix clipped descenders in headings (y, g, p, q, j) */
2800+
article h1,
2801+
.prose h1 {
2802+
line-height: 1.3 !important; /* Increase line-height to prevent clipping */
2803+
padding-bottom: 0.2rem !important; /* Add padding to ensure descenders are visible */
2804+
overflow: visible !important; /* Ensure text isn't clipped */
2805+
}
2806+
2807+
article h2,
2808+
.prose h2 {
2809+
line-height: 1.4 !important;
2810+
padding-bottom: 0.15rem !important;
2811+
overflow: visible !important;
2812+
}
2813+
2814+
article h3,
2815+
.prose h3 {
2816+
line-height: 1.4 !important;
2817+
padding-bottom: 0.1rem !important;
2818+
overflow: visible !important;
2819+
}
2820+
2821+
2822+
/* Reduce excessive spacing - fine-tuned values */
2823+
article h1,
2824+
.prose h1 {
2825+
margin-bottom: 1rem !important; /* Reduced from 1.5rem */
2826+
}
2827+
2828+
/* Reduce top margin on first paragraph after title */
2829+
article h1 + p,
2830+
.prose h1 + p {
2831+
margin-top: 1rem !important; /* Consistent spacing after H1 */
2832+
}
2833+
2834+
/* Adjust H2 spacing to be less aggressive */
2835+
article h2,
2836+
.prose h2 {
2837+
margin-top: 1.75rem !important; /* Reduced from 2rem */
2838+
margin-bottom: 0.75rem !important; /* Reduced from 1rem */
2839+
}
2840+
2841+
/* Adjust paragraph spacing */
2842+
article p,
2843+
.prose p {
2844+
margin-top: 0.75rem !important; /* Reduced */
2845+
margin-bottom: 0.75rem !important; /* Reduced */
2846+
}
2847+
2848+
/* Adjust image spacing */
2849+
article img,
2850+
.prose img {
2851+
margin-top: 1.25rem !important; /* Reduced from 1.5rem */
2852+
margin-bottom: 1.25rem !important; /* Reduced from 1.5rem */
2853+
}
2854+
2855+
2856+
/* Reduce top padding/margin above page title across all docs pages */
2857+
article,
2858+
.markdown,
2859+
[class*='docItemContainer'] article {
2860+
padding-top: 1rem !important; /* Reduced top padding */
2861+
}
2862+
2863+
/* Reduce margin-top on the H1 title itself */
2864+
article h1:first-of-type,
2865+
.prose h1:first-of-type,
2866+
.markdown h1:first-of-type {
2867+
margin-top: 0.5rem !important; /* Minimal top margin for first H1 */
2868+
}
2869+
2870+
/* Remove excessive top margin from article header */
2871+
article header {
2872+
margin-top: 0 !important;
2873+
padding-top: 0 !important;
2874+
}
2875+
2876+
/* Reduce top margin on first element after breadcrumbs */
2877+
.theme-doc-breadcrumbs + * {
2878+
margin-top: 1rem !important;
2879+
}
2880+
2881+
2882+
/* OVERRIDE: Reduce top margin/padding on markdown container - more specific selectors */
2883+
div.theme-doc-markdown.markdown,
2884+
.theme-doc-markdown,
2885+
[class*='theme-doc-markdown'] {
2886+
margin-top: 0 !important;
2887+
padding-top: 0.5rem !important; /* Minimal top padding */
2888+
}
2889+
2890+
/* Target the prose container specifically */
2891+
.prose.md\\:prose-md.prose-auto.my-12 {
2892+
margin-top: 1rem !important; /* Override my-12 class */
2893+
margin-bottom: 1rem !important;
2894+
}
2895+
2896+
/* Remove large top margin from article/main content */
2897+
main article,
2898+
[class*='docItemContainer'] {
2899+
margin-top: 0 !important;
2900+
padding-top: 0.5rem !important;
2901+
}
2902+
2903+
2904+
/* EQUAL SPACING: Make top and bottom spacing around H1 consistent */
2905+
/* This creates better visual balance for documentation pages */
2906+
2907+
/* Set consistent spacing after breadcrumbs */
2908+
nav.theme-doc-breadcrumbs {
2909+
margin-bottom: 1.5rem !important; /* Equal to H1 bottom margin */
2910+
}
2911+
2912+
/* Ensure H1 has equal spacing on both sides */
2913+
article h1:first-of-type,
2914+
.prose h1:first-of-type {
2915+
margin-top: 0 !important; /* No extra top margin */
2916+
margin-bottom: 1.5rem !important; /* Match breadcrumb spacing */
2917+
}
2918+
2919+
/* Remove any extra padding from containers */
2920+
.theme-doc-markdown.markdown {
2921+
padding-top: 0 !important;
2922+
}
2923+
2924+
/* Table header vertical alignment - align headers to top of cells */
2925+
table th {
2926+
vertical-align: top !important;
2927+
}
2928+

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,10 @@ tags:
1414
- plugin
1515
---
1616

17+
import ProductTier from '@site/src/components/ProductTier';
18+
19+
<ProductTier tiers="Open Source, Enterprise" offerings="Self-Hosted, Dedicated" />
20+
1721
Keploy can be integrated with GitHub by two methods:-
1822

1923
1. [Using Shell Scripts](#shell-scripts)
@@ -34,10 +38,6 @@ GitHub scripts are the easiest way to integrate Keploy with GitHub. We will be u
3438
...
3539
```
3640

37-
> **Note: if you are using `arm_64` as runner use below to download keploy binary**
38-
39-
`curl --silent --location "https://github.com/keploy/keploy/releases/latest/download/keploy_linux_arm64.tar.gz" | tar xz --overwrite -C /tmp`
40-
4141
### Example with Scripts
4242

4343
While using [express-mongoose](https://github.com/keploy/samples-typescript/tree/main/express-mongoose) sample-application with keploy test in GitHub CI, the workflow would like:-

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

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,10 @@ tags:
1414
- plugin
1515
---
1616

17+
import ProductTier from '@site/src/components/ProductTier';
18+
19+
<ProductTier tiers="Open Source, Enterprise" offerings="Self-Hosted, Dedicated" />
20+
1721
Keploy can integrated with GitLab CI to streamline your testing process and ensure continuous testing as part of your CI/CD pipeline.
1822

1923
## Create pipeline
@@ -41,10 +45,6 @@ keploy-test-job: # This job runs in the test stage.
4145
...
4246
```
4347

44-
> **Note: if you are using `arm_64` as runner use below to download keploy binary**
45-
46-
`curl --silent --location "https://github.com/keploy/keploy/releases/latest/download/keploy_linux_arm64.tar.gz" | tar xz --overwrite -C /tmp`
47-
4848
Now that we have Keploy installed, and all ready, we need switch to path where `keploy` folder is present in our application and install all the application related dependencies. Since we are using [flask-mongo](https://github.com/keploy/samples-python) sample-application, steps in our `script:` would look like below:-
4949

5050
```yaml
@@ -66,17 +66,15 @@ In your `.gitlab-ci.yml file`, in last step we have `keploy test` command to run
6666

6767
### 📝 Note
6868

69-
Did you notice some weird stuff in the pipeline? Like `kmod`, `linux-headers`, `/sys/kernel/debug`...and thought, _"Wait, am I hacking the kernel or something?"_ 😅
69+
Did you notice some weird stuff in the pipeline? Like `kmod`, `linux-headers`, `/sys/kernel/debug`
7070

7171
Don’t worry — these are just there because **Keploy uses eBPF** (a cool Linux feature) to trace your app’s behavior.
7272

7373
So we install `kmod`, `linux-headers-generic`, and `bpfcc-tools` to make that tracing possible.
7474

75-
Some CI systems don’t have `/sys/kernel/debug` and `/sys/kernel/tracing` by default, so we create them and mount `debugfs` and `tracefs` — it’s like giving Keploy the **backstage pass** it needs to watch your app in action.
76-
77-
No black magic. Just some low-level Linux stuff helping your tests run like magic! 🪄✨
75+
Some CI systems don’t have `/sys/kernel/debug` and `/sys/kernel/tracing` by default, so we create them and mount `debugfs` and `tracefs`
7876

79-
We will get to see output : -
77+
We would output something like below:-
8078

8179
```sh
8280
$ keploy test -c "python3 app.py" --delay 50

0 commit comments

Comments
 (0)