Skip to content

Conversation

@AntTheLimey
Copy link
Member

@AntTheLimey AntTheLimey commented Jan 21, 2026

Summary

  • Add llms.txt file following the emerging convention for providing LLMs with structured context about a website
  • Includes overview of pgEdge products, deployment options, extensions, AI toolkit, and documentation links

Why

As an AI-forward company with an AI Toolkit, having an llms.txt helps AI assistants provide accurate information about pgEdge products when users ask questions.

Test plan

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation
    • Added comprehensive documentation covering pgEdge capabilities, deployment options, core extensions, AI toolkit components, operations tools, and resources with relevant links and technical information.

✏️ Tip: You can customize this high-level summary in your review settings.

Provides structured information about pgEdge products and documentation
for LLMs and AI assistants, following the llms.txt convention.

Co-Authored-By: Claude Opus 4.5 <[email protected]>
@coderabbitai
Copy link

coderabbitai bot commented Jan 21, 2026

Walkthrough

Adds a new documentation file detailing pgEdge's capabilities, including deployment options, core extensions, AI toolkit components, and operations tools with relevant URLs and technical stack information organized into structured sections.

Changes

Cohort / File(s) Summary
Documentation
docs/llms.txt
New documentation file covering pgEdge platform features, deployment options, core extensions, AI toolkit components, operations tools, and resources with associated links and tech stack details (+95 lines)

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The pull request title 'Add llms.txt for AI assistant context' accurately describes the main change: adding a new llms.txt documentation file designed to provide structured context for AI assistants.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 2

🤖 Fix all issues with AI agents
In `@docs/llms.txt`:
- Line 7: Update the sentence text to hyphenate the compound adjective: change
"100% standard, open source PostgreSQL" to "100% standard, open-source
PostgreSQL" so "open-source" correctly modifies "PostgreSQL" as a compound
adjective.
- Around line 1-95: The two broken links under the "Kubernetes (Containers)" and
"VMs & Bare Metal" sections (currently pointing to
https://docs.pgedge.com/container-images/ and https://docs.pgedge.com/ansible/)
must be corrected: locate those URLs in docs/llms.txt (look for the "Kubernetes
(Containers)" and "VMs & Bare Metal" headings and the lines containing
container-images and ansible) and replace each with the correct documentation
page (or a valid parent path such as the main docs root) after verifying the
canonical URLs on the docs site; ensure the updated links match existing docs
pages and test they no longer return 404.

Comment on lines +1 to +95
# pgEdge Documentation

> pgEdge provides enterprise-ready PostgreSQL with multi-master replication capabilities, enabling globally distributed, active-active database deployments.

## About pgEdge

pgEdge delivers hardened, production-grade PostgreSQL with a seamless path from single database deployments to globally distributed multi-master clusters. Built on 100% standard, open source PostgreSQL.

**Key Capabilities:**
- Multi-master (active-active) replication with write-anywhere capability
- Sub-50ms latency through geographic distribution
- Zero-downtime operations and instant failover
- Data sovereignty with granular replication control

## Deployment Options

### pgEdge Cloud
Fully managed PostgreSQL service. Provision clusters across AWS, Azure, or GCP.
- Documentation: https://docs.pgedge.com/cloud/

### Kubernetes (Containers)
Cloud-native deployments with Helm charts and CloudNativePG integration.
- Helm Chart: https://docs.pgedge.com/pgedge-containers/
- Container Images: https://docs.pgedge.com/container-images/

### VMs & Bare Metal
Direct installations on virtual machines or physical servers.
- Package Repository (RPM/APT): https://docs.pgedge.com/enterprise/
- Distributed CLI: https://docs.pgedge.com/platform/
- Control Plane API: https://docs.pgedge.com/control-plane/
- Ansible: https://docs.pgedge.com/ansible/

## Core Extensions

### Spock v5
Logical multi-master replication with bi-directional data flow and automatic conflict resolution.
- Documentation: https://docs.pgedge.com/spock-v5/

### LOLOR
Large object replication for handling BLOBs in distributed environments.
- Documentation: https://docs.pgedge.com/lolor/

### Snowflake
Distributed sequence generation for cluster-wide unique IDs.
- Documentation: https://docs.pgedge.com/snowflake/

## AI Toolkit

pgEdge provides production-ready AI infrastructure for PostgreSQL:

### MCP Server
Model Context Protocol server enabling AI agents to interact with PostgreSQL databases.
- Documentation: https://docs.pgedge.com/pgedge-postgres-mcp-server/

### RAG Server
High-performance Retrieval-Augmented Generation API with hybrid search.
- Documentation: https://docs.pgedge.com/pgedge-rag-server/

### Vectorizer
Automatic document chunking and vector embedding generation as a PostgreSQL extension.
- Documentation: https://docs.pgedge.com/pgedge-vectorizer/

### DocLoader
Command-line utility for loading documents into PostgreSQL for AI applications.
- Documentation: https://docs.pgedge.com/pgedge-docloader/

## Operations Tools

### ACE (Active Consistency Engine)
Automated data integrity verification and repair across replicated clusters.
- Documentation: https://docs.pgedge.com/ace/

### Control Plane
Declarative API for database lifecycle management and orchestration.
- Documentation: https://docs.pgedge.com/control-plane/

### Radar
Agentless diagnostic data collection for PostgreSQL and system metrics.
- Documentation: https://docs.pgedge.com/radar/

### Anonymizer
PII replacement tool for creating safe dev/test database copies.
- Documentation: https://docs.pgedge.com/pgedge-anonymizer/

## Resources

- Website: https://www.pgedge.com
- GitHub: https://github.com/pgEdge
- Discord: https://discord.com/invite/pgedge
- Support: https://www.pgedge.com/support

## Documentation Site

- Main documentation: https://docs.pgedge.com
- Built with MkDocs and Material for MkDocs theme
Copy link

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟠 Major

🧩 Analysis chain

🏁 Script executed:

#!/bin/bash
# Extract and test all HTTPS URLs from docs/llms.txt

urls=$(grep -oP 'https://[^\s]+' docs/llms.txt | sort -u)

echo "Testing URL accessibility..."
echo "=========================================="

failed_urls=()
passed_urls=()

for url in $urls; do
  # Remove any trailing markdown characters
  url_clean=$(echo "$url" | sed 's/[`\)\]\*]*$//')
  
  status=$(curl -s -o /dev/null -w "%{http_code}" -L --connect-timeout 5 "$url_clean" 2>/dev/null)
  
  if [ "$status" -eq 200 ]; then
    echo "$url_clean (HTTP $status)"
    passed_urls+=("$url_clean")
  else
    echo "$url_clean (HTTP $status)"
    failed_urls+=("$url_clean")
  fi
done

echo "=========================================="
echo "Summary:"
echo "Passed: ${`#passed_urls`[@]}"
echo "Failed: ${`#failed_urls`[@]}"

if [ ${`#failed_urls`[@]} -gt 0 ]; then
  echo ""
  echo "Failed URLs:"
  for url in "${failed_urls[@]}"; do
    echo "  - $url"
  done
fi

Repository: pgEdge/pgedge-docs

Length of output: 1368


Fix broken documentation URLs.

Two documentation links return HTTP 404 errors:

  • Line 23: https://docs.pgedge.com/container-images/
  • Line 24: https://docs.pgedge.com/ansible/

These URLs need to be corrected or replaced to ensure all documentation links are accessible.

🧰 Tools
🪛 LanguageTool

[grammar] ~7-~7: Use a hyphen to join words.
Context: ...r clusters. Built on 100% standard, open source PostgreSQL. **Key Capabilities:*...

(QB_NEW_EN_HYPHEN)

🤖 Prompt for AI Agents
In `@docs/llms.txt` around lines 1 - 95, The two broken links under the
"Kubernetes (Containers)" and "VMs & Bare Metal" sections (currently pointing to
https://docs.pgedge.com/container-images/ and https://docs.pgedge.com/ansible/)
must be corrected: locate those URLs in docs/llms.txt (look for the "Kubernetes
(Containers)" and "VMs & Bare Metal" headings and the lines containing
container-images and ansible) and replace each with the correct documentation
page (or a valid parent path such as the main docs root) after verifying the
canonical URLs on the docs site; ensure the updated links match existing docs
pages and test they no longer return 404.


## About pgEdge

pgEdge delivers hardened, production-grade PostgreSQL with a seamless path from single database deployments to globally distributed multi-master clusters. Built on 100% standard, open source PostgreSQL.
Copy link

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor

Hyphenate compound adjective.

When "open source" modifies a noun as a compound adjective, it should be hyphenated as "open-source".

📝 Proposed fix
-pgEdge delivers hardened, production-grade PostgreSQL with a seamless path from single database deployments to globally distributed multi-master clusters. Built on 100% standard, open source PostgreSQL.
+pgEdge delivers hardened, production-grade PostgreSQL with a seamless path from single database deployments to globally distributed multi-master clusters. Built on 100% standard, open-source PostgreSQL.
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
pgEdge delivers hardened, production-grade PostgreSQL with a seamless path from single database deployments to globally distributed multi-master clusters. Built on 100% standard, open source PostgreSQL.
pgEdge delivers hardened, production-grade PostgreSQL with a seamless path from single database deployments to globally distributed multi-master clusters. Built on 100% standard, open-source PostgreSQL.
🧰 Tools
🪛 LanguageTool

[grammar] ~7-~7: Use a hyphen to join words.
Context: ...r clusters. Built on 100% standard, open source PostgreSQL. **Key Capabilities:*...

(QB_NEW_EN_HYPHEN)

🤖 Prompt for AI Agents
In `@docs/llms.txt` at line 7, Update the sentence text to hyphenate the compound
adjective: change "100% standard, open source PostgreSQL" to "100% standard,
open-source PostgreSQL" so "open-source" correctly modifies "PostgreSQL" as a
compound adjective.

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.

1 participant