Remove deprecated v3.0.0 docs and UI Changes by atishaytripathi · Pull Request #785 · keploy/docs

atishaytripathi · 2026-02-11T08:33:56Z

🚀 Comprehensive PR Description: Documentation Refinement & Version Consolidation

This PR represents a systematic overhaul of the Keploy documentation to improve maintainability, resolve build-breaking routing conflicts, and enhance the overall reading experience. Below is a detailed section-by-section breakdown of every change made since the main branch.

🛠️ Core Configuration & Infrastructure Changes

File Path	Change Summary	Technical Reason
docusaurus.config.js	Converted to CommonJS; updated versioning logic	Stability: Converted `import` to `require` to fix module resolution errors in the editor ($ts-check). Set `lastVersion: "3.0.0"` and restored stable analytics logic.
package.json	Added `unist-util-visit`	Dependency Fix: Explicitly added a missing sub-dependency required by custom Markdown processing plugins in our config.
versions.json	Removed `"3.0.0"`	Consolidation: Streamlined the version list to `["3.0.0", "2.0.0", "1.0.0"]`, making the latest features the default "maintained" version.
sidebars.js	Restored base structure	Cleanup: Reverted to a clean Docusaurus sidebar foundation to ensure logical navigation rendering across deployments.

🎨 UI & User Experience Refinements

File Path	Change Summary	Design Rationale
src/css/custom.css	Implemented "Consistent Spacing System"	Readability: Standardized vertical rhythm (margins/padding) for H1-H3, paragraphs, and images. Fixed "clipped descenders" on headings where letters like 'g' or 'y' were being cut off at the bottom.
src/css/custom.css	Table Header Alignment	Visual Clarity: Forced table headers (`th`) to `vertical-align: top`, ensuring information alignment in multi-line comparison tables.

📂 Documentation Versioning & Structural Promotion

1. Version 3.0.0 Promotion (The New Maintained Version)

Originally located in version 4.0.0, these files have been promoted to Version 3.0.0 to represent the current state-of-the-art.

File Path	Specific Change	Critical Reason
`.../server/linux/installation.md`	`id: installation` → `id: linux-installation`	Resolution: Docusaurus cannot have duplicate IDs. This change resolves build-breaking routing conflicts between OS platforms.
`.../server/windows/installation.md`	`id: installation` → `id: windows-installation`	Resolution: Same as above; ensures stable navigation links for Windows users.
`.../server/macos/installation.md`	`id: installation` → `id: macos-installation`	Resolution: Same as above; ensures stable navigation links for macOS users.
`.../quickstart/sample-apps.md`	Title: "Quickstart Guide"	SEO: Replaced "Quickstart filter" with a human-readable title to improve search engine indexing and user onboarding.
`.../keploy-cloud/kubernetes-local-setup.md`	New integration docs	Expansion: Added specialized documentation for localized Kubernetes testing environments (via promotion).
`.../running-keploy/api-testing-auth-setup.md`	New auth guide	Expansion: Detailed technical steps for configuring authentication in the promoted v3 tier.

2. Version 3.0.0 Archive (Data Preservation)

The original Version 3.0.0 content has been preserved to avoid any data loss while keeping the active site clean.

Action: Moved all previous version-3.0.0 content to versioned_docs/version-3.0.0-archive/.
Reason: This ensures that historical documentation remains accessible in the codebase for reference without confusing new users who expect "Version 3.0.0" to represent the latest stable interface.

📸 Visual Evidence

1. Sidebar Reference Fix

The promotion of content required updating the id tags to prevent circular or duplicate references.

Changes made due to build failure because of duplicate IDs in previous version.

2. Typography & Spacing

Applied global CSS to ensure headings have enough line-height so that descenders (j, p, q, y) are not visually clipped by the container overflow.

Spacing issues in between the paragraphs

Header alignment from the top of the corresponding box (in table)

Applied global CSS to ensure headings have enough line-height so that descenders (j, p, q, y) are not visually clipped by the container overflow.
- Before
- After

✅ Checklist

Build Status: Verified via npm run build with zero routing or duplicate ID errors.
Editor Support: TypeScript/Vale errors previously cluttering the IDE have been cleared.
Versioning Verification: The site now defaults to Version 3.0.0 (promoted content) as the maintained version.

github-actions

Thank you and congratulations 🎉 for opening your very first pull request in keploy

kiloconnect · 2026-02-11T08:36:45Z

Code Review Summary

Status: No Issues Found | Recommendation: Merge

Overview

This PR restructures the documentation versioning by:

Removing version 4.0.0 and making 3.0.0 the latest version
Archiving version 4.0.0 content to version-3.0.0-archive
Converting ESM imports to CommonJS in docusaurus.config.js
Adding unist-util-visit as an explicit dependency
Temporarily disabling gtag due to a runtime error

The CSS changes are purely formatting (whitespace adjustments around > selectors) and are valid CSS.

Files Reviewed (6 files)

docusaurus.config.js - Config changes, import style, version updates
package.json - Added dependency
sidebars.js - Added boilerplate config
src/css/custom.css - Formatting changes only
versions.json - Removed 4.0.0
versioned_sidebars/*.json - Sidebar config updates

Note: The existing inline comments about invalid CSS selectors (\u003e) appear to be false positives. The actual CSS file contains valid > characters, not escaped unicode sequences.

Signed-off-by: Atishay Tripathi <atishay1922@gmail.com>

kiloconnect · 2026-02-11T13:07:41Z

src/css/custom.css

+  margin-bottom: 1.5rem !important; /* Consistent space after images */
+}
+
+article \u003e div[style*='backgroundColor'] {


CRITICAL: Invalid CSS selector - \u003e should be >

The literal string \u003e is being used instead of the > (child combinator) character. This CSS selector will not work as intended.

Suggested change

article \u003e div[style*='backgroundColor'] {

article > div[style*='backgroundColor'] {

resolved this

kiloconnect · 2026-02-11T13:07:42Z

src/css/custom.css

+}
+
+/* Fix the large top margin on first element after header */
+.markdown \u003e *:first-child,


CRITICAL: Invalid CSS selector - \u003e should be >

Same issue as above - the literal string \u003e should be replaced with the > character.

Suggested change

.markdown \u003e *:first-child,

.markdown > *:first-child,

resolved this

kiloconnect · 2026-02-11T13:07:42Z

src/css/custom.css

+
+/* Fix the large top margin on first element after header */
+.markdown \u003e *:first-child,
+article \u003e .markdown \u003e *:first-child {


CRITICAL: Invalid CSS selector - \u003e should be >

Multiple occurrences of \u003e that should be > characters.

Suggested change

article \u003e .markdown \u003e *:first-child {

article > .markdown > *:first-child {

resolved this

atishaytripathi · 2026-02-11T13:08:33Z

🚀 PR Changelog: Version Consolidation & Technical Refinement

This commit consolidates the documentation versioning structure, promoting the latest features to Version 3.0.0 and archiving obsolete data. It also preserves critical technical fixes for build stability and editor performance.

🔄 What was Undone/Restored

Version Baseline: Reverted versioned_docs, versioned_sidebars, and versions.json to their original origin/main state before performing the final, hyper-specific migration. This ensured no "ghost files" from previous merge attempts remained.

✅ What was Preserved (Not Undone)

Editor Sync (CommonJS Fix): Maintained the conversion of import to require statements in docusaurus.config.js. This resolves the mixed-module syntax errors flagged by the TypeScript checker (// @ts-check).
Core Dependencies: Kept unist-util-visit in package.json which is required for the configuration logic to function.
UI Polish: Preserved all recent styling refinements in src/css/custom.css.

🚀 Version Migration (v4.0.0 → v3.0.0)

Archival (Zero Data Loss):
- versioned_docs/version-3.0.0 → Renamed to version-3.0.0-archive.
- versioned_sidebars/version-3.0.0-sidebars.json → Renamed to version-3.0.0-archive-sidebars.json.
Promotion:
- versioned_docs/version-4.0.0 → Renamed to version-3.0.0.
- versioned_sidebars/version-4.0.0-sidebars.json → Renamed to version-3.0.0-sidebars.json.
Maintained State: Set v3.0.0 as the lastVersion (current maintained version).

📁 File Changes Summary

File	Action	Description
`versions.json`	Updated	Reduced versions to `["3.0.0", "2.0.0", "1.0.0"]`.
`docusaurus.config.js`	Updated	Updated version metadata; added archive reference comments.
`versioned_docs/v3.0.0/...`	Renamed	Now contains high-quality content originally from v4.0.0.
`server/installation.md` (v3)	Fixed	Resolved `id` conflicts (Windows/Linux/Mac) to fix build crashes.
`*.log`	Deleted	Cleaned up temporary build residue.

📚 Related Issues

Closes https://github.com/keploy/product/issues/9

🛠️ Build Status: PASSING

The project has been verified with npm run build. Static files were generated successfully in the build directory without any duplicate-id or sidebar-reference errors.

Achanandhi-M

Please update the PR description

atishaytripathi · 2026-02-12T06:05:19Z

Please update the PR description

Hi, the topmost comment is the updated one. @Achanandhi-M

Signed-off-by: Atishay Tripathi <atishay1922@gmail.com>

atishaytripathi · 2026-02-13T06:16:51Z

@amaan-bhati - please review this PR

github-actions bot reviewed Feb 11, 2026

View reviewed changes

chore: version changes post review

d53c2dc

Signed-off-by: Atishay Tripathi <atishay1922@gmail.com>

atishaytripathi force-pushed the docs/product-refinement branch from dc76a67 to d53c2dc Compare February 11, 2026 13:05

kiloconnect bot reviewed Feb 11, 2026

View reviewed changes

Achanandhi-M requested changes Feb 11, 2026

View reviewed changes

atishaytripathi changed the title ~~Remove deprecated v4.0.0 docs and improve spacing consistency~~ Remove deprecated v3.0.0 docs and UI Changes Feb 12, 2026

chore: solved ui issues

e0caeeb

Signed-off-by: Atishay Tripathi <atishay1922@gmail.com>

atishaytripathi requested a review from amaan-bhati February 13, 2026 06:17

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Remove deprecated v3.0.0 docs and UI Changes#785

Remove deprecated v3.0.0 docs and UI Changes#785
atishaytripathi wants to merge 2 commits intomainfrom
docs/product-refinement

atishaytripathi commented Feb 11, 2026 •

edited

Loading

Uh oh!

github-actions bot left a comment

Uh oh!

kiloconnect bot commented Feb 11, 2026 •

edited

Loading

Uh oh!

kiloconnect bot Feb 11, 2026

Uh oh!

atishaytripathi Feb 13, 2026

Uh oh!

kiloconnect bot Feb 11, 2026

Uh oh!

atishaytripathi Feb 13, 2026

Uh oh!

kiloconnect bot Feb 11, 2026

Uh oh!

atishaytripathi Feb 13, 2026

Uh oh!

atishaytripathi commented Feb 11, 2026 •

edited

Loading

Uh oh!

Achanandhi-M left a comment •

edited

Loading

Uh oh!

atishaytripathi commented Feb 12, 2026 •

edited

Loading

Uh oh!

atishaytripathi commented Feb 13, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

	article \u003e div[style*='backgroundColor'] {
	article > div[style*='backgroundColor'] {

	article \u003e .markdown \u003e *:first-child {
	article > .markdown > *:first-child {

Uh oh!

Conversation

atishaytripathi commented Feb 11, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🚀 Comprehensive PR Description: Documentation Refinement & Version Consolidation

🛠️ Core Configuration & Infrastructure Changes

🎨 UI & User Experience Refinements

📂 Documentation Versioning & Structural Promotion

1. Version 3.0.0 Promotion (The New Maintained Version)

2. Version 3.0.0 Archive (Data Preservation)

📸 Visual Evidence

1. Sidebar Reference Fix

2. Typography & Spacing

✅ Checklist

Uh oh!

github-actions bot left a comment

Choose a reason for hiding this comment

Uh oh!

kiloconnect bot commented Feb 11, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Code Review Summary

Overview

Uh oh!

kiloconnect bot Feb 11, 2026

Choose a reason for hiding this comment

Uh oh!

atishaytripathi Feb 13, 2026

Choose a reason for hiding this comment

Uh oh!

kiloconnect bot Feb 11, 2026

Choose a reason for hiding this comment

Uh oh!

atishaytripathi Feb 13, 2026

Choose a reason for hiding this comment

Uh oh!

kiloconnect bot Feb 11, 2026

Choose a reason for hiding this comment

Uh oh!

atishaytripathi Feb 13, 2026

Choose a reason for hiding this comment

Uh oh!

atishaytripathi commented Feb 11, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🚀 PR Changelog: Version Consolidation & Technical Refinement

🔄 What was Undone/Restored

✅ What was Preserved (Not Undone)

🚀 Version Migration (v4.0.0 → v3.0.0)

📁 File Changes Summary

📚 Related Issues

🛠️ Build Status: PASSING

Uh oh!

Achanandhi-M left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

atishaytripathi commented Feb 12, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

atishaytripathi commented Feb 13, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

atishaytripathi commented Feb 11, 2026 •

edited

Loading

kiloconnect bot commented Feb 11, 2026 •

edited

Loading

atishaytripathi commented Feb 11, 2026 •

edited

Loading

Achanandhi-M left a comment •

edited

Loading

atishaytripathi commented Feb 12, 2026 •

edited

Loading