Skip to content

predictable-labs/ryugraph-docs

Repository files navigation

Ryu Documentation

Built with Starlight

This is the official documentation site for RyuGraph, an embedded graph database built for query speed and scalability. Ryu is optimized for handling complex analytical workloads on very large databases and provides a comprehensive set of retrieval features, including full text search and vector indices.

About Ryu

Ryu, a fork of Kuzu, is an embedded graph database built for query speed and scalability. Ryu is optimized for handling complex analytical workloads on very large databases and provides a set of retrieval features, such as a full text search and vector indices. Our core feature set includes:

  • Flexible Property Graph Data Model and Cypher query language
  • Embeddable, serverless integration into applications
  • Native full text search and vector index
  • Columnar disk-based storage
  • Columnar sparse row-based (CSR) adjacency list/join indices
  • Vectorized and factorized query processor
  • Novel and very fast join algorithms
  • Multi-core query parallelism
  • Serializable ACID transactions
  • Wasm (WebAssembly) bindings for fast, secure execution in the browser

Ryu or RyuGraph is a fork of Kuzu, which was originally developed by Kuzu Inc. Following Kuzu's archival in October 2025, Ryu continues the development and evolution of this embedded graph database technology. Ryu is maintained by Predictable Labs, Inc. and is available under a permissible license, ensuring the continued advancement of this innovative graph database solution.

Documentation Site

This documentation site is built with Astro and Starlight. The sections below describe the site's structure and the commands for installation, local development and build instructions.

🚀 Project Structure

Inside of this Astro + Starlight project, there exist the following folders and files:

.
├── public/
├── src/
│   ├── assets/
│   ├── content/
│   │   ├── docs/
│   │   └── config.ts
│   └── env.d.ts
├── astro.config.mjs
├── package.json
└── tsconfig.json

Starlight looks for .md or .mdx files in the src/content/docs/ directory. Each file is exposed as a route based on its file name.

Note

MDX combines JSX and Markdown to make it easier to write component-driven content like tabbed code blocks. Starlight requires that you work with .mdx files instead of .md when using JSX components. See the official documentation for more information on MDX syntax and why it exists.

Images are added to src/assets/ and embedded in Markdown with a relative link.

Any additional static assets (like fonts, favicon, PDFs, etc.) that will not be processed by Astro are placed in the public/ directory.

Customizations

Table Syntax Highlighting

Add tag "table" after the three backticks to indicate the table custom css style to code block

Usage:

┌─────────┬─────────┬─────────┐
│ column1 │ column2 │ column3 │
├─────────┼─────────┼─────────┤
│ value1  │ value2  │ value3  │
└─────────┴─────────┴─────────┘

Tab Synchronization

Include "syncKey=<syncKey_name>" to Tabs tag. To have tabs synchronize, ensure <syncKey_name> are the same across different tabs. The tabitems do not need to be the same. Identical tabitems will have synchronization applied to them when clicked.

Usage:

Pressing on "Rust" will result in both tabs switching onto Rust.

🧞 Commands

All commands are run from the root of the project, from a terminal:

Command Action
npm install Installs dependencies
npm run dev Starts local dev server at localhost:4321
npm start Starts local server and builds site
npm run build Build your production site to ./dist/
npm run preview Preview your build locally, before deploying
npm run astro ... Run CLI commands like astro add, astro check
npm run astro -- --help Get help using the Astro CLI
npm run check-links Check for broken links in the documentation

👀 Learn more

Check out Starlight’s docs and read the Astro documentation for further customization of the site.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •