-
Notifications
You must be signed in to change notification settings - Fork 3.5k
docs: update EdgeDB references to Gel rebrand #24487
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
WalkthroughDocumentation and site metadata were updated to reflect a rebrand from EdgeDB to Gel: link text and guide paths changed, and the ecosystem guide content was fully rewritten to use Gel names, CLI, file references, imports, and package/tooling names. Changes
Pre-merge checks✅ Passed checks (4 passed)
📜 Recent review detailsConfiguration used: Path: .coderabbit.yaml Review profile: ASSERTIVE Plan: Pro Disabled knowledge base sources:
📒 Files selected for processing (1)
🔇 Additional comments (1)
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. Comment |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 1
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro
Disabled knowledge base sources:
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (1)
docs/guides/ecosystem/edgedb.mdx(2 hunks)
Update all EdgeDB documentation to reflect rebrand to Gel: - Update guide title from "Use EdgeDB with Bun" to "Use Gel with Bun" - Update CLI commands (edgedb → gel) - Update npm packages (edgedb → gel, @edgedb/generate → @gel/generate) - Update installation URLs and scripts - Update all code examples and imports - Add "(formerly EdgeDB)" note to description Fixes oven-sh#17721
6ada2f4 to
e75babc
Compare
There was a problem hiding this 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
♻️ Duplicate comments (1)
docs/snippets/guides.jsx (1)
126-126: Inconsistency between title and URL path (duplicate).Same issue as in README.md: The title displays "Use Gel with Bun" but href remains
/guides/ecosystem/edgedb. This creates a mismatch between branding and navigation paths.
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro
Disabled knowledge base sources:
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (3)
README.md(1 hunks)docs/guides/ecosystem/edgedb.mdx(9 hunks)docs/snippets/guides.jsx(1 hunks)
🧰 Additional context used
🧠 Learnings (6)
📚 Learning: 2025-08-30T00:12:56.803Z
Learnt from: CR
Repo: oven-sh/bun PR: 0
File: .cursor/rules/writing-tests.mdc:0-0
Timestamp: 2025-08-30T00:12:56.803Z
Learning: Applies to test/**/*.{js,ts} : Write tests in JavaScript or TypeScript using Bun’s Jest-style APIs (test, describe, expect) and run with bun test
Applied to files:
README.md
📚 Learning: 2025-10-19T02:44:46.354Z
Learnt from: theshadow27
Repo: oven-sh/bun PR: 23798
File: packages/bun-otel/context-propagation.test.ts:1-1
Timestamp: 2025-10-19T02:44:46.354Z
Learning: In the Bun repository, standalone packages under packages/ (e.g., bun-vscode, bun-inspector-protocol, bun-plugin-yaml, bun-plugin-svelte, bun-debug-adapter-protocol, bun-otel) co-locate their tests with package source code using *.test.ts files. This follows standard npm/monorepo patterns. The test/ directory hierarchy (test/js/bun/, test/cli/, test/js/node/) is reserved for testing Bun's core runtime APIs and built-in functionality, not standalone packages.
Applied to files:
README.md
📚 Learning: 2025-10-15T04:01:16.478Z
Learnt from: AmanVarshney01
Repo: oven-sh/bun PR: 23580
File: docs/guides/ecosystem/prisma.md:21-26
Timestamp: 2025-10-15T04:01:16.478Z
Learning: For Prisma with Bun runtime and Rust-free client (engineType "client"), when using local SQLite files (file:// URLs), use either prisma/adapter-better-sqlite3 or the Bun-native synapsenwerkstatt/prisma-bun-sqlite-adapter. The prisma/adapter-libsql adapter is only for remote libSQL/Turso endpoints and will not work with local SQLite file URLs.
Applied to files:
README.md
📚 Learning: 2025-10-04T09:52:49.414Z
Learnt from: CR
Repo: oven-sh/bun PR: 0
File: src/js/CLAUDE.md:0-0
Timestamp: 2025-10-04T09:52:49.414Z
Learning: Applies to src/js/bun/**/*.{ts,js} : Place Bun-specific modules (e.g., bun:ffi, bun:sqlite) under bun/
Applied to files:
README.md
📚 Learning: 2025-10-19T02:52:37.412Z
Learnt from: theshadow27
Repo: oven-sh/bun PR: 23798
File: packages/bun-otel/tsconfig.json:1-15
Timestamp: 2025-10-19T02:52:37.412Z
Learning: In the Bun repository, packages under packages/ (e.g., bun-otel) can follow a TypeScript-first pattern where package.json exports point directly to .ts files (not compiled .js files). Bun natively runs TypeScript, so consumers import .ts sources directly and receive full type information without needing compiled .d.ts declaration files. For such packages, adding "declaration": true or "outDir" in tsconfig.json is unnecessary and would break the export structure.
<!-- [remove_learning]
ceedde95-980e-4898-a2c6-40ff73913664
Applied to files:
README.md
📚 Learning: 2025-09-02T05:33:37.517Z
Learnt from: Jarred-Sumner
Repo: oven-sh/bun PR: 22323
File: test/js/web/websocket/websocket-subprotocol.test.ts:74-75
Timestamp: 2025-09-02T05:33:37.517Z
Learning: In Bun's runtime, `await using` with Node.js APIs like `net.createServer()` is properly supported and should not be replaced with explicit cleanup. Bun has extended Node.js APIs with proper async dispose support.
Applied to files:
README.md
🔇 Additional comments (2)
docs/guides/ecosystem/edgedb.mdx (2)
135-136: Verified: npm packages exist and are published.Both package names referenced in the guide are valid and available on npm:
gel: v2.1.1@gel/generate: v0.7.0The installation commands will not fail due to package unavailability.
Likely an incorrect or invalid review comment.
40-40: All review concerns have been verified and found to be unfounded.The guide is accurate:
The gel CLI is officially distributed via https://www.geldata.com/sh and https://www.geldata.com/ps1, which matches the installation scripts shown in the guide.
The command name has been officially changed from edgedb to gel, as confirmed by the guide's opening statement: "Gel (formerly EdgeDB)".
All commands documented in the guide (
gel project init,gel migration create, andgel migrate) are officially supported. The guide correctly reflects the current gel CLI API.No changes needed.
Likely an incorrect or invalid review comment.
Replace broken geldata.com URLs with functional docs.geldata.com endpoints: - Update install link to docs.geldata.com/learn/installation (was 404) - Update docs reference to docs.geldata.com (was broken redirect) - Add Homebrew installation method for additional options Addresses CodeRabbit review feedback about non-functional URLs.
Rename guide file from edgedb.mdx to gel.mdx and update all references: - Rename docs/guides/ecosystem/edgedb.mdx to gel.mdx - Update path references in README.md, docs.json, and guides.jsx - Maintain consistency with Gel rebrand throughout documentation This ensures URL paths match the new Gel branding.
Summary
EdgeDB has rebranded to Gel. This PR comprehensively updates all documentation to reflect the rebrand.
Changes Made
Documentation & Branding
docs/guides/ecosystem/edgedb.mdx→gel.mdx/guides/ecosystem/edgedbto/guides/ecosystem/gelCLI Commands
edgedb project init→gel project initedgedb→gel(REPL)edgedb migration create→gel migration createedgedb migrate→gel migratenpm Packages
edgedb→gel@edgedb/generate→@gel/generateInstallation & Documentation URLs
docs.geldata.com/learn/installation(functional)docs.geldata.com/(operational)https://www.geldata.com/shandps1)brew install geldata/tap/gel-cliCode Examples
import { createClient } from "gel"bunx @gel/generateVerified
All commands verified against official Gel documentation at https://docs.geldata.com/
Fixes #17721