Skip to content

aeo update#818

Open
nehagup wants to merge 4 commits intomainfrom
aeo
Open

aeo update#818
nehagup wants to merge 4 commits intomainfrom
aeo

Conversation

@nehagup
Copy link
Copy Markdown
Member

@nehagup nehagup commented Apr 1, 2026

This pull request introduces several improvements to Keploy's documentation and site metadata, focusing on clearer explanations of core concepts, enhanced SEO and discoverability, and improved support for AI and search engine indexing. The most important changes include more comprehensive descriptions of Keploy features and architecture, the addition of a structured FAQ schema component, and updates to robots.txt to allow major AI agents and bots.

Documentation content and clarity improvements:

  • Updated feature and concept pages (e.g., what-is-keploy.md, what-are-keploy-features.md, how-keploy-works.md, what-is-a-keploy-ebpf.md) to provide clearer, more detailed descriptions of Keploy’s AI-powered testing, eBPF-based traffic capture, production-like sandboxing, and other core capabilities. Added relevant keywords for improved searchability. [1] [2] [3] [4] [5] [6]

  • Added a new documentation file, llms.txt, summarizing Keploy’s features, use cases, and integration guides in a format suitable for AI and search engine consumption.

SEO and AI discoverability enhancements:

  • Introduced a new React component, FAQSchema.jsx, that generates and injects a structured FAQ schema (FAQPage JSON-LD) for better search engine and AI assistant understanding of FAQ content.

  • Updated robots.txt to explicitly allow major AI bots and search-related crawlers (e.g., GPTBot, OAI-SearchBot, ClaudeBot, PerplexityBot, Google-Extended, etc.) while disallowing Bytespider, improving Keploy’s visibility in AI-powered search and assistant platforms.## What has changed?

Please include a summary of the change.

This PR Resolves #(issue)

Type of change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue).
  • New feature (non-breaking change which adds functionality).
  • Breaking change (fix or feature that would cause existing functionality to not work as expected).
  • Documentation update (if none of the other choices apply).

How Has This Been Tested?

Please run npm run build and npm run serve to check if the changes are working as expected. Please include screenshots of the output of both the commands. Add screenshots/gif of the changes if possible.

Checklist:

  • My code follows the style guidelines of this project.
  • I have performed a self-review of my own code.

Neha Gupta and others added 2 commits April 2, 2026 00:53
Signed-off-by: Neha Gupta <gneha21[at]yahoo>
FAQSchema.jsx was never imported anywhere — dead code with no matching
visible FAQ content, risking structured-data spam if accidentally used.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Signed-off-by: slayerjain <shubhamkjain@outlook.com>
Copilot AI review requested due to automatic review settings April 1, 2026 19:48
@kilo-code-bot
Copy link
Copy Markdown

kilo-code-bot bot commented Apr 1, 2026

Code Review Summary

Status: No New Issues Found | Recommendation: Merge

Overview

This incremental review covers changes since commit d82a5ea. The PR continues to improve Keploy's documentation SEO and AI discoverability by:

  • Enhancing docusaurus.config.js with improved schema.org SoftwareApplication markup and social media sameAs links
  • Adding a package.json manifest for the existing docusaurus-tailwindcss-loader plugin
  • Extending static/llms.txt with a "Related Resources" section
  • Adding SEO-optimized question-format headings and summary paragraphs to version 3.0.0 and 4.0.0 documentation

No new critical issues were found in the incremental changes. Previous inline comments from the initial review remain applicable.

Previous Issues Still Applicable (6 issues)
File Line Issue
static/robots.txt 35 Per-user-agent groups may not inherit Disallow: /cgi-bin/
versioned_docs/version-4.0.0/keploy-explained/how-keploy-works.md 5 Description phrasing "replay it as production-like sandboxes" is confusing
versioned_docs/version-4.0.0/keploy-explained/how-keploy-works.md 23 Technically imprecise eBPF/packet terminology
versioned_docs/version-4.0.0/concepts/what-is-a-keploy-ebpf.md 5 "intercept network packets at the socket level" is inconsistent
versioned_docs/version-4.0.0/concepts/what-is-keploy.md 34 "Linux kernel network layer" may be read as OSI L3
static/llms.txt 3 PR description mentions FAQSchema.jsx not present in this PR
Other Observations (not in diff)
File Line Issue
versioned_docs/version-4.0.0/keploy-explained/how-keploy-works.md 62 Typo: "testicles" should likely be "test cases" (pre-existing issue)
versioned_docs/version-3.0.0/keploy-explained/how-keploy-works.md 15 Same eBPF terminology as flagged in 4.0.0 docs
versioned_docs/version-3.0.0/concepts/what-are-keploy-features.md 83 Similar "Linux kernel's network layer" phrasing
Files Reviewed in This Increment (10 files)
  • docusaurus.config.js - Enhanced schema.org markup, social links
  • plugins/docusaurus-tailwindcss-loader/package.json - New plugin manifest
  • static/llms.txt - Added Related Resources section
  • static/robots.txt - No changes in increment
  • versioned_docs/version-3.0.0/concepts/what-are-keploy-features.md - Added SEO headings/summaries
  • versioned_docs/version-3.0.0/concepts/what-is-keploy.md - Added summary paragraph
  • versioned_docs/version-3.0.0/keploy-explained/how-keploy-works.md - Added summary paragraphs
  • versioned_docs/version-4.0.0/concepts/what-is-a-keploy-ebpf.md - Enhanced SEO metadata
  • versioned_docs/version-4.0.0/concepts/what-is-keploy.md - Enhanced SEO metadata
  • versioned_docs/version-4.0.0/keploy-explained/how-keploy-works.md - Enhanced SEO metadata

Reviewed by claude-4.5-opus-20251124 · 473,529 tokens

Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR updates Keploy documentation metadata/content and site crawling/indexing artifacts to improve SEO and AI discoverability.

Changes:

  • Expanded key concept docs with richer frontmatter (description, keywords) and introductory explanations.
  • Updated robots.txt to explicitly allow major AI/search bots while disallowing Bytespider.
  • Added static/llms.txt to provide an AI-friendly entrypoint summarizing Keploy docs and key links.

Reviewed changes

Copilot reviewed 6 out of 6 changed files in this pull request and generated 6 comments.

Show a summary per file
File Description
versioned_docs/version-4.0.0/keploy-explained/how-keploy-works.md Adds meta description/keywords and a clearer intro explaining record/replay architecture.
versioned_docs/version-4.0.0/concepts/what-is-keploy.md Updates product description and adds keywords/intro paragraph for search clarity.
versioned_docs/version-4.0.0/concepts/what-is-a-keploy-ebpf.md Clarifies eBPF concept with expanded description/keywords and an explanatory intro.
versioned_docs/version-4.0.0/concepts/what-are-keploy-features.md Expands features description/keywords and adds a summarized “key features” intro paragraph.
static/robots.txt Adds explicit AI bot allow rules, disallows Bytespider, retains default crawler directives.
static/llms.txt Introduces an AI-oriented overview file with curated links into the docs.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment on lines +2 to +35
Allow: /

User-agent: OAI-SearchBot
Allow: /

User-agent: ChatGPT-User
Allow: /

User-agent: ClaudeBot
Allow: /

User-agent: anthropic-ai
Allow: /

User-agent: PerplexityBot
Allow: /

User-agent: Perplexity-User
Allow: /

User-agent: Google-Extended
Allow: /

User-agent: GoogleOther
Allow: /

User-agent: Applebot-Extended
Allow: /

User-agent: Meta-ExternalAgent
Allow: /

User-agent: CCBot
Allow: /
Copy link

Copilot AI Apr 1, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The per-user-agent groups (e.g., GPTBot/ClaudeBot/etc.) only contain Allow: /. Because crawlers use the most specific matching group, these bots will no longer inherit the Disallow: /cgi-bin/ rule from the User-agent: * group and may crawl /cgi-bin/. Consider either removing the redundant allow-groups (and only keeping the Bytespider block), or repeating Disallow: /cgi-bin/ (and any other shared directives) within each explicit user-agent group.

Suggested change
Allow: /
User-agent: OAI-SearchBot
Allow: /
User-agent: ChatGPT-User
Allow: /
User-agent: ClaudeBot
Allow: /
User-agent: anthropic-ai
Allow: /
User-agent: PerplexityBot
Allow: /
User-agent: Perplexity-User
Allow: /
User-agent: Google-Extended
Allow: /
User-agent: GoogleOther
Allow: /
User-agent: Applebot-Extended
Allow: /
User-agent: Meta-ExternalAgent
Allow: /
User-agent: CCBot
Allow: /
Allow: /
Disallow: /cgi-bin/
User-agent: OAI-SearchBot
Allow: /
Disallow: /cgi-bin/
User-agent: ChatGPT-User
Allow: /
Disallow: /cgi-bin/
User-agent: ClaudeBot
Allow: /
Disallow: /cgi-bin/
User-agent: anthropic-ai
Allow: /
Disallow: /cgi-bin/
User-agent: PerplexityBot
Allow: /
Disallow: /cgi-bin/
User-agent: Perplexity-User
Allow: /
Disallow: /cgi-bin/
User-agent: Google-Extended
Allow: /
Disallow: /cgi-bin/
User-agent: GoogleOther
Allow: /
Disallow: /cgi-bin/
User-agent: Applebot-Extended
Allow: /
Disallow: /cgi-bin/
User-agent: Meta-ExternalAgent
Allow: /
Disallow: /cgi-bin/
User-agent: CCBot
Allow: /
Disallow: /cgi-bin/

Copilot uses AI. Check for mistakes.
id: how-keploy-works
title: How Keploy Works?
sidebar_label: Architecture
description: Keploy uses eBPF hooks at the Linux kernel level to capture real user traffic in Record mode and replay it as production-like sandboxes in Test mode — enabling production behavior replay, dependency virtualization, and continuous validation with automatic regression detection.
Copy link

Copilot AI Apr 1, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The description says "replay it as production-like sandboxes" which reads like the traffic is being replayed as a sandbox. Consider rephrasing to replay the captured traffic/requests in a production-like sandbox environment (or similar) to avoid confusion.

Copilot uses AI. Check for mistakes.
- legacy application testing
---

Keploy generates tests by using eBPF hooks to intercept network packets at the Linux kernel level. In Record mode, it captures every incoming HTTP request and outgoing dependency call — database queries, API calls, message queue interactions — saving them as YAML test cases. In Test mode, it replays those requests as production-like sandboxes with all dependencies automatically virtualized, comparing responses to detect regressions. This production behavior replay enables continuous validation, migration regression testing, and legacy application testing without code changes.
Copy link

Copilot AI Apr 1, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This line mixes a few potentially confusing/incorrect terms: eBPF typically attaches to kernel hooks and can observe socket/syscall-level I/O rather than literally "intercepting network packets", and "replays those requests as production-like sandboxes" is awkward phrasing. Consider updating wording to something like capturing socket-level traffic via eBPF hooks and replaying requests in a sandboxed environment.

Suggested change
Keploy generates tests by using eBPF hooks to intercept network packets at the Linux kernel level. In Record mode, it captures every incoming HTTP request and outgoing dependency call — database queries, API calls, message queue interactions — saving them as YAML test cases. In Test mode, it replays those requests as production-like sandboxes with all dependencies automatically virtualized, comparing responses to detect regressions. This production behavior replay enables continuous validation, migration regression testing, and legacy application testing without code changes.
Keploy generates tests by using eBPF hooks in the Linux kernel to capture socket-level application traffic. In Record mode, it captures every incoming HTTP request and outgoing dependency call — database queries, API calls, message queue interactions — saving them as YAML test cases. In Test mode, it replays those requests in a sandboxed environment that closely mimics production, with all dependencies automatically virtualized and responses compared to detect regressions. This production behavior replay enables continuous validation, migration regression testing, and legacy application testing without code changes.

Copilot uses AI. Check for mistakes.
title: What is Keploy eBPF
sidebar_label: Keploy eBPF
description: Keploy eBPF is a language-agnostic library that captures and replays API calls and subsequent network interactions.
description: eBPF (Extended Berkeley Packet Filter) is a Linux kernel technology that Keploy uses to intercept network packets at the socket level with near-zero overhead — enabling production behavior replay, dependency virtualization, legacy application testing, and infrastructure mocking without code changes.
Copy link

Copilot AI Apr 1, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The wording "intercept network packets at the socket level" is internally inconsistent (packets are L3/L2, sockets are L4+ API) and may be technically misleading. Consider describing this as capturing socket-level traffic / syscall-level network I/O via eBPF hooks, rather than intercepting packets.

Copilot uses AI. Check for mistakes.
- AI Generated Tests
---

Keploy is an open-source, AI-powered testing agent and sandboxing platform that uses eBPF to automatically generate test cases, dependency mocks, and production-like sandboxes from real user traffic. It records live API calls at the Linux kernel network layer and replays them as deterministic tests — requiring zero code changes, working with any programming language or framework, and scaling test coverage with AI-driven code velocity. Keploy enables production behavior replay, dependency virtualization for databases and external APIs, legacy application testing without code changes, and migration regression testing against production baselines.
Copy link

Copilot AI Apr 1, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"Linux kernel network layer" can be read as the OSI network layer (L3). If Keploy’s capture is happening at the socket/syscall layer (as suggested elsewhere), consider using more precise phrasing (e.g., kernel socket layer / syscall-level network I/O) to avoid technical ambiguity.

Suggested change
Keploy is an open-source, AI-powered testing agent and sandboxing platform that uses eBPF to automatically generate test cases, dependency mocks, and production-like sandboxes from real user traffic. It records live API calls at the Linux kernel network layer and replays them as deterministic tests — requiring zero code changes, working with any programming language or framework, and scaling test coverage with AI-driven code velocity. Keploy enables production behavior replay, dependency virtualization for databases and external APIs, legacy application testing without code changes, and migration regression testing against production baselines.
Keploy is an open-source, AI-powered testing agent and sandboxing platform that uses eBPF to automatically generate test cases, dependency mocks, and production-like sandboxes from real user traffic. It records live API calls at the Linux kernel socket layer (syscall-level network I/O) and replays them as deterministic tests — requiring zero code changes, working with any programming language or framework, and scaling test coverage with AI-driven code velocity. Keploy enables production behavior replay, dependency virtualization for databases and external APIs, legacy application testing without code changes, and migration regression testing against production baselines.

Copilot uses AI. Check for mistakes.
Comment on lines +1 to +3
# Keploy Documentation

> Technical documentation for Keploy, an open-source AI-powered testing agent and sandboxing platform that automatically generates test cases, dependency mocks, and production-like sandboxes from real user traffic using eBPF kernel technology. Keploy keeps testing aligned with AI-driven code velocity — achieving 90% test coverage in minutes with zero code changes.
Copy link

Copilot AI Apr 1, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

PR description mentions introducing a new FAQSchema.jsx component for structured FAQ JSON-LD, but this PR’s changed file set doesn’t include that component. If the component isn’t actually part of this PR (or wasn’t updated here), consider updating the PR description to avoid confusion for reviewers/release notes.

Copilot uses AI. Check for mistakes.
…g, sitemap

- Add 40-60 word answer nuggets after H2s in what-is-keploy, how-keploy-works, features docs
- Rephrase doc headings as questions for AI extraction
- Upgrade Product schema to SoftwareApplication with featureList and keywords
- Add sameAs entity disambiguation links to Organization schema
- Add blog + landing cross-refs to llms.txt
- Fix canonicalBase to match actual domain (keploy.io)
- Add missing plugin package.json for docusaurus-tailwindcss-loader
- Configure sitemap filename

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Signed-off-by: slayerjain <shubhamkjain@outlook.com>
@nehagup nehagup requested a review from Copilot April 2, 2026 09:49
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 11 out of 11 changed files in this pull request and generated 2 comments.


💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment on lines +80 to +86
"operatingSystem": ["Linux", "macOS", "Windows"],
"license": "https://www.apache.org/licenses/LICENSE-2.0",
"softwareHelp": "https://docs.keploy.io",
"codeRepository": "https://github.com/keploy/keploy",
"downloadUrl": "https://github.com/keploy/keploy/releases",
"isAccessibleForFree": true,
"url": "https://keploy.io",
Copy link

Copilot AI Apr 2, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In the SoftwareApplication JSON-LD, softwareHelp points to https://docs.keploy.io, but this site is configured with url: "https://keploy.io" and baseUrl: "/docs/", so the docs home resolves to https://keploy.io/docs/. Consider aligning softwareHelp with the configured docs URL (or update url/baseUrl if the canonical host is actually docs.keploy.io) to avoid inconsistent structured data.

Copilot uses AI. Check for mistakes.
Comment on lines 69 to +76
tagName: "script",
attributes: {
type: "application/ld+json",
},
innerHTML: JSON.stringify({
"@context": "https://schema.org/",
"@type": "Product",
description:
"Keploy - Open source tool that generates integration tests like unit tests with mocks or stubs from API calls.",
keywords:
"API testing, incident replay, network calls, code paths, test scenarios, code coverage, stubs, junit, go-test, live environment, production incidents, open source, regression tests, ai tests",
name: "Keploy",
url: "https://keploy.io/",
logo: "https://keploy.io/docs/img/favicon.png",
"@context": "https://schema.org",
"@type": "SoftwareApplication",
"name": "Keploy",
Copy link

Copilot AI Apr 2, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The PR description mentions adding a new FAQSchema.jsx component to inject FAQPage JSON-LD, but there is no FAQSchema implementation in this PR (repo-wide search returns no matches). Either add the component + wiring, or update the PR description to match the actual changes.

Copilot uses AI. Check for mistakes.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants