Skip to content

README.md

Latest commit

 

History

History
160 lines (114 loc) · 5.49 KB

README.md

File metadata and controls

160 lines (114 loc) · 5.49 KB

Workflow Discord Try Free

Trendshift

FalkorDB Documentation

Welcome to the FalkorDB documentation repository. This repository contains the source files for https://docs.falkordb.com.

About FalkorDB

FalkorDB is a low-latency, scalable graph database with OpenCypher support. It powers GraphRAG applications and serves as a high-performance property graph database for complex, interconnected data.

Documentation Structure

  • Getting Started: Installation, configuration, and client libraries
  • Cypher: Query language reference and examples
  • Commands: FalkorDB-specific commands
  • Algorithms: Graph algorithms (BFS, PageRank, etc.)
  • GenAI Tools: Integration with LlamaIndex, LangChain, and GraphRAG frameworks
  • Operations: Deployment, clustering, and infrastructure
  • Integration: Third-party tool integrations

Prerequisites

To build and run the documentation locally, you need:

  • Ruby (2.7 or later)
  • Bundler gem

Local Development

Install Dependencies

bundle install

Build the Documentation

bundle exec jekyll build

Run Local Server

bundle exec jekyll serve

The documentation will be available at http://localhost:4000.

Contributing

We welcome contributions to improve the documentation! Here's how you can help:

Reporting Issues

If you find errors, typos, or unclear explanations:

  1. Check if an issue already exists in the issue tracker
  2. If not, create a new issue with:
    • Clear description of the problem
    • Location in the documentation (file path and line number)
    • Suggested improvement (if applicable)

Submitting Changes

  1. Fork the repository
  2. Create a feature branch (git checkout -b improve-documentation)
  3. Make your changes
  4. Test locally with bundle exec jekyll serve
  5. Commit your changes with clear, descriptive messages
  6. Push to your fork
  7. Open a Pull Request with:
    • Description of changes
    • Reason for the changes
    • Screenshots (if visual changes)

Style Guidelines

  • Use clear, concise language
  • Include code examples where appropriate
  • Follow existing formatting and structure
  • Test all code examples
  • Use proper Markdown syntax
  • Keep line length reasonable (under 120 characters when possible)

Code Examples

When adding code examples:

  • Provide examples in multiple languages when applicable (Python, JavaScript, Java, Rust)
  • Ensure code is tested and working
  • Include comments for complex operations
  • Use realistic, meaningful variable names

Reusable Components

The _includes/ directory contains reusable Jekyll include components:

code_tabs.html — Multi-language code tabs

Renders tabbed code blocks for Python, JavaScript, C++, Rust, Java, and Shell.

{% include code_tabs.html id="unique_id" python=python_var shell=shell_var %}

faq_accordion.html — FAQ accordion

Renders an accessible, no-JavaScript FAQ accordion using native <details>/<summary> elements. Accepts up to 10 question/answer pairs via q1/a1 … q10/a10 parameters. An optional title parameter adds a header bar with the title and a count badge showing the total number of items. Set open1="true" … open10="true" on any item to render it expanded by default.

{% include faq_accordion.html
  title="Frequently Asked Questions"
  q1="What is FalkorDB?"
  a1="FalkorDB is a high-performance graph database."
  open1="true"
  q2="How do I get started?"
  a2="See the [Getting Started](/getting-started) guide."
%}

Answers are passed through the markdownify filter, so standard Markdown syntax (bold, links, code spans, etc.) is supported within answer strings.

See References/license.md for a full example using this component.

Project Structure

docs/
├── algorithms/          # Graph algorithms documentation
├── commands/            # Command reference
├── cypher/             # Cypher query language docs
├── genai-tools/        # AI/ML integrations
├── getting-started/    # Installation and setup
├── integration/        # Third-party integrations
├── operations/         # Deployment and operations
├── udfs/              # User-defined functions
├── _config.yml        # Jekyll configuration
└── index.md           # Homepage

License

The documentation is licensed under Creative Commons Attribution 4.0 International (CC BY 4.0).

FalkorDB itself is licensed under the Server Side Public License v1 (SSPLv1).

Support