Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/deploy-ghcr.yml
Original file line number Diff line number Diff line change
Expand Up @@ -29,4 +29,4 @@ jobs:
context: .
platforms: linux/amd64,linux/arm64
push: true
tags: ghcr.io/lbugdb/dev-docs:latest
tags: ghcr.io/ladybugdb/dev-docs:latest
2 changes: 1 addition & 1 deletion compose.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
services:
ladybug-docs-server:
image: ghcr.io/lbugdb/dev-docs
image: ghcr.io/ladybugdb/dev-docs
pull_policy: always
ports:
- "8082:80"
Expand Down
2 changes: 1 addition & 1 deletion scripts/generate-llms.cjs
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ const matter = require('gray-matter');

const docsDir = path.join(__dirname, '../src/content/docs');
const outputFile = path.join(__dirname, '../public/llms.txt');
const baseUrl = 'https://lbugdb.github.io/docs';
const baseUrl = 'https://docs.ladybugdb.com/';

const header = "# Ladybug Documentation\n\n> Comprehensive documentation for Ladybug, an embedded (in-process), scalable, blazing fast graph database.\n";

Expand Down
2 changes: 1 addition & 1 deletion src/content/docs/client-apis/c.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ Alternatively, here is an example configuration for integrating the pre-built li

### Linking against Ladybug when built from source

See the requirements in https://lbugdb.github.io/docs/developer-guide/.
See the requirements in https://docs.ladybugdb.com/developer-guide/.
It's recommended that you use CMake if you want to link to the lbug static library as shown in the example below.

#### CMake
Expand Down
2 changes: 1 addition & 1 deletion src/content/docs/client-apis/cli.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ lbug> :help
Note: you can change and see several system configurations, such as num-threads,
timeout, and progress_bar using Cypher CALL statements.
e.g. CALL THREADS=5; or CALL current_setting('threads') return *;
See: https://lbugdb.github.io/docs/cypher/configuration
See: https://docs.ladybugdb.com/cypher/configuration
```

#### `:clear`
Expand Down
2 changes: 1 addition & 1 deletion src/content/docs/client-apis/go.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,5 +9,5 @@ See the following link for the full documentation of the `go-lbug` package.

<LinkCard
title="Go API documentation"
href="https://pkg.go.dev/github.com/LadybugDB/go-lbug"
href="https://pkg.go.dev/github.com/LadybugDB/go-ladybug"
/>
8 changes: 4 additions & 4 deletions src/content/docs/client-apis/python.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -22,10 +22,10 @@ and is more convenient to use.
Download the [CSV files](https://github.com/LadybugDB/ladybug/tree/master/dataset/demo-db/csv) used in the examples below:
```bash
mkdir ./data/
curl -L -o ./data/city.csv https://raw.githubusercontent.com/lbugdb/lbug/refs/heads/master/dataset/demo-db/csv/city.csv
curl -L -o ./data/user.csv https://raw.githubusercontent.com/lbugdb/lbug/refs/heads/master/dataset/demo-db/csv/user.csv
curl -L -o ./data/follows.csv https://raw.githubusercontent.com/lbugdb/lbug/refs/heads/master/dataset/demo-db/csv/follows.csv
curl -L -o ./data/lives-in.csv https://raw.githubusercontent.com/lbugdb/lbug/refs/heads/master/dataset/demo-db/csv/lives-in.csv
curl -L -o ./data/city.csv https://raw.githubusercontent.com/ladybugdb/ladybug/refs/heads/master/dataset/demo-db/csv/city.csv
curl -L -o ./data/user.csv https://raw.githubusercontent.com/ladybugdb/ladybug/refs/heads/master/dataset/demo-db/csv/user.csv
curl -L -o ./data/follows.csv https://raw.githubusercontent.com/ladybugdb/ladybug/refs/heads/master/dataset/demo-db/csv/follows.csv
curl -L -o ./data/lives-in.csv https://raw.githubusercontent.com/ladybugdb/ladybug/refs/heads/master/dataset/demo-db/csv/lives-in.csv
```

<Tabs syncKey="sync">
Expand Down
2 changes: 1 addition & 1 deletion src/content/docs/developer-guide/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: Developer guide for building Ladybug from source code with CMake, P

:::caution[Note]
This page is intended for developers who want to build Ladybug from source. If you are a user of Ladybug,
please refer to the [installation guide](https://lbugdb.github.io/docs/installation) for downloading pre-built binaries for your platform.
please refer to the [installation guide](https://docs.ladybugdb.com/installation) for downloading pre-built binaries for your platform.
:::

To build from source code, Ladybug requires CMake (`>=3.15`), Python (`>=3.9`), and a compiler that supports C++20. The minimum supported versions of C++ compilers are GCC 12, Clang 18, and MSVC 19.20. The preferred compiler on Linux is GCC; on macOS, Apple Clang; and on Windows, MSVC. On Linux, Clang is also tested. Other compilers that support C++20 may also work, but are not tested.
Expand Down
4 changes: 2 additions & 2 deletions src/content/docs/developer-guide/join-order-hint.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ For experimental purposes, or when the optimizer provides a sub-optimal plan, yo
by using the `HINT` clause and writing a join order. This works as follows:
- Join hints work within the scope of a single `MATCH` pattern.
- The pattern must be connected, e.g., it cannot be `MATCH (a:Person), (b:Person) RETURN *;` where there are 2 disconnected components.
- Every node/relationship variable must be named and appear in the join order exactly once. Relationship variables can be [recursive](https://lbugdb.github.io/docs/cypher/query-clauses/match/#match-variable-lengthrecursive-relationships), e.g., `-[e*1..3]->` or `-[e* SHORTEST]->`.
- Every node/relationship variable must be named and appear in the join order exactly once. Relationship variables can be [recursive](https://docs.ladybugdb.com/cypher/query-clauses/match/#match-variable-lengthrecursive-relationships), e.g., `-[e*1..3]->` or `-[e* SHORTEST]->`.
- The join order is a binary tree, expressed through the structure of the parentheses inside the `HINT` clause. Every sub-tree in the plan specified by `HINT` must be connected.

As an example, the below hint enforces a query plan that scans edges using backward adjacency lists from `b`:
Expand Down Expand Up @@ -53,7 +53,7 @@ same plan because such joins are compiled as scanning node tables followed by sc

### MULTI_JOIN clause: Worst-case optimal join plans

Ladybug plans can use a combination of binary join operators and [worst-case optimal join (WCOJ)](https://lbugdb.github.io/blog/post/wcoj/) operators.
Ladybug plans can use a combination of binary join operators and worst-case optimal join (WCOJ) operators.
WCOJ operators are useful if your `MATCH` pattern contains cycles, e.g., when finding triangles or larger cliques of nodes in your databases.
Using HINT, you can also force the optimizer to use a WCOJ operator as follows:

Expand Down
6 changes: 3 additions & 3 deletions src/content/docs/extensions/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -133,11 +133,11 @@ Uninstalling a currently loaded extension won't affect the running database inst

You can host your own extension server for Ladybug using Docker.

The extension server is based on NGINX and is hosted on [GitHub](https://ghcr.io/lbugdb/extension-repo). You can pull the Docker image and run it in your environment:
The extension server is based on NGINX and is hosted on [GitHub](https://ghcr.io/ladybugdb/extension-repo). You can pull the Docker image and run it in your environment:

```bash
docker pull ghcr.io/lbugdb/extension-repo:latest
docker run -d -p 8080:80 ghcr.io/lbugdb/extension-repo:latest
docker pull ghcr.io/ladybugdb/extension-repo:latest
docker run -d -p 8080:80 ghcr.io/ladybugdb/extension-repo:latest
```

In this example, the extension server will be available at `http://localhost:8080`. You can then install extensions from your server by appending the `FROM` clause to the `INSTALL` command:
Expand Down
2 changes: 1 addition & 1 deletion src/content/docs/get-started/graph-algorithms.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ in Python to run almost any graph algorithm on a Ladybug subgraph.
## Prepare the dataset

A dataset of Nobel laureates and their mentorship network is provided
[here](https://raw.githubusercontent.com/lbugdb/tutorials/main/src/network_analysis/data.zip).
[here](https://raw.githubusercontent.com/ladybugdb/ladybug/tutorials/main/src/network_analysis/data.zip).
Download the dataset to your local directory and unzip it.

The nodes in the dataset are scholars who won Nobel prizes, as well as other
Expand Down
14 changes: 7 additions & 7 deletions src/content/docs/get-started/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -41,15 +41,15 @@ let package = Package(
.iOS(.v14),
],
dependencies: [
.package(url: "https://github.com/LadybugDB/ladybug-swift/", branch: "${version}"),
.package(url: "https://github.com/LadybugDB/swift-ladybug/", branch: "${version}"),
],
targets: [
// Targets are the basic building blocks of a package, defining a module or a test suite.
// Targets can depend on other targets in this package and products from dependencies.
.executableTarget(
name: "lbug-swift-example",
name: "swift-ladybug-example",
dependencies: [
.product(name: "Ladybug", package: "lbug-swift"),
.product(name: "Ladybug", package: "swift-ladybug"),
]
),
]
Expand Down Expand Up @@ -97,10 +97,10 @@ Also download the example CSV files [from our GitHub repo](https://github.com/La

```bash
mkdir ./data/
curl -L -o ./data/city.csv https://raw.githubusercontent.com/lbugdb/lbug/refs/heads/master/dataset/demo-db/csv/city.csv
curl -L -o ./data/user.csv https://raw.githubusercontent.com/lbugdb/lbug/refs/heads/master/dataset/demo-db/csv/user.csv
curl -L -o ./data/follows.csv https://raw.githubusercontent.com/lbugdb/lbug/refs/heads/master/dataset/demo-db/csv/follows.csv
curl -L -o ./data/lives-in.csv https://raw.githubusercontent.com/lbugdb/lbug/refs/heads/master/dataset/demo-db/csv/lives-in.csv
curl -L -o ./data/city.csv https://raw.githubusercontent.com/ladybugdb/ladybug/refs/heads/master/dataset/demo-db/csv/city.csv
curl -L -o ./data/user.csv https://raw.githubusercontent.com/ladybugdb/ladybug/refs/heads/master/dataset/demo-db/csv/user.csv
curl -L -o ./data/follows.csv https://raw.githubusercontent.com/ladybugdb/ladybug/refs/heads/master/dataset/demo-db/csv/follows.csv
curl -L -o ./data/lives-in.csv https://raw.githubusercontent.com/ladybugdb/ladybug/refs/heads/master/dataset/demo-db/csv/lives-in.csv
```

In this example, we will create a graph with two node types, `User` and `City`, and two relationship types, `Follows` and `LivesIn`.
Expand Down