Skip to content

docs: add GraphRAG Server page for non-expert users#493

Merged
galshubeli merged 11 commits into
mainfrom
docs/graphrag-server-page
Jun 3, 2026
Merged

docs: add GraphRAG Server page for non-expert users#493
galshubeli merged 11 commits into
mainfrom
docs/graphrag-server-page

Conversation

@galshubeli
Copy link
Copy Markdown
Contributor

@galshubeli galshubeli commented Jun 3, 2026

What

Adds a new documentation page, GraphRAG Server, under GenAI Tools describing the hosted GraphRAG app at https://graphrag.falkordb.com/.

The page is written for the non-expert reader: someone who isn't a graph / knowledge-graph specialist and just wants an easy, accurate RAG solution. It is deliberately conceptual and product-focused (no Docker, env vars, config tables, or API reference), since the product is hosted-only.

Page contents

  • One-line value prop + a clickable landing-page hero image linking to graphrag.falkordb.com
  • Resources (Try it, FalkorDB, GraphRAG-SDK repo)
  • Why GraphRAG?: accuracy, citations, explainability, visual exploration (vs. vanilla RAG), in plain language
  • How it works: sign in, upload, ask, explore
  • Key features (user-facing)
  • Brief embeddable widget mention

This complements, and is clearly distinguished from, the developer-facing GraphRAG-SDK page (the Python library).

Other changes

  • Added the page to the GenAI Tools index (genai-tools/index.md)
  • Inserted at nav_order: 2 (right after GraphRAG-SDK) and renumbered the sibling pages; gave code-graph a unique nav_order (10) to resolve a pre-existing duplicate
  • Added explainability and Markdown to .wordlist.txt for the spellcheck CI
  • Added images/graphrag-server-hero.png (cropped landing-page hero)

Verification

  • pyspelling -c .spellcheck.yml -n Markdown -> Spelling check passed
  • Frontmatter and formatting mirror the existing graphrag-sdk.md conventions
  • Jekyll was not built locally (Ruby unavailable in this environment); relying on the docs preview build

🤖 Generated with Claude Code

Add a user-facing page for the hosted GraphRAG Server app
(graphrag.falkordb.com), written for readers who aren't graph/KG
experts and just want an easy, accurate RAG solution. Covers why
GraphRAG, the upload→ask→explore workflow, key features, the
embeddable widget, and an FAQ. Distinct from the developer-facing
GraphRAG-SDK page.

Insert at nav_order 2 in GenAI Tools (right after GraphRAG-SDK) and
renumber siblings; add explainability/Markdown to the spellcheck
wordlist.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Jun 3, 2026

📝 Walkthrough

Walkthrough

This PR adds a new GraphRAG Server product documentation page with comprehensive overview, features, embedding instructions, and FAQ. Supporting spell-check terms are added, and existing GenAI tools documentation pages have navigation order values incremented to accommodate the new page in the site hierarchy.

Changes

GraphRAG Server Documentation Addition

Layer / File(s) Summary
GraphRAG Server documentation and wordlist updates
genai-tools/graphrag-server.md, .wordlist.txt
New 72-line documentation page for GraphRAG Server product covering what it is, use cases, workflow, features (upload, Q&A, citations, explainability, visualization), embedding instructions, and FAQ. Two spell-check terms (explainability, Markdown) added to wordlist.
Navigation integration
genai-tools/index.md, genai-tools/ag2.md, genai-tools/langchain.md, genai-tools/langgraph.md, genai-tools/llamaindex.md, genai-tools/graphrag-toolkit.md, genai-tools/code-graph.md, genai-tools/mcpserver/index.md, genai-tools/queryweaver.md
GraphRAG Server entry added to GenAI Tools topic list; nav_order values incremented across all existing docs (AG2: 2→3, LangChain: 3→4, LangGraph: 4→5, LlamaIndex: 5→6, GraphRAG Toolkit: 6→7, MCP Server: 7→8, Code Graph: 8→9, QueryWeaver: 8→9).

🎯 2 (Simple) | ⏱️ ~10 minutes

🐰 A new server hops into the docs,
GraphRAG's wisdom stops and pops,
Navigation reordered neat,
Knowledge-graphs, a tasty treat! 📚✨

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The PR title accurately reflects the main change: adding a new GraphRAG Server documentation page targeted at non-expert users. This is the primary objective of the PR, supported by the new file, index update, and nav_order adjustments.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.

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

✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/graphrag-server-page

Warning

Review ran into problems

🔥 Problems

Git: Failed to clone repository. Please run the @coderabbitai full review command to re-trigger a full review. If the issue persists, set path_filters to include or exclude specific files.


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
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Adds end-user focused documentation for the hosted GraphRAG Server app and updates the GenAI Tools navigation/spellcheck dictionary to surface it cleanly in the docs site.

Changes:

  • Added a new GraphRAG Server page under GenAI Tools with conceptual guidance, features, and FAQ.
  • Updated GenAI Tools index and reordered sibling pages via nav_order updates.
  • Extended .wordlist.txt to satisfy spellcheck CI for new terminology.

Reviewed changes

Copilot reviewed 11 out of 11 changed files in this pull request and generated 2 comments.

Show a summary per file
File Description
genai-tools/graphrag-server.md New hosted-product documentation page (non-expert oriented).
genai-tools/index.md Adds GraphRAG Server to the GenAI Tools topic list.
genai-tools/ag2.md nav_order shift due to new page insertion.
genai-tools/langchain.md nav_order shift due to new page insertion.
genai-tools/langgraph.md nav_order shift due to new page insertion.
genai-tools/llamaindex.md nav_order shift due to new page insertion.
genai-tools/graphrag-toolkit.md nav_order shift due to new page insertion.
genai-tools/mcpserver/index.md nav_order shift due to new page insertion.
genai-tools/queryweaver.md nav_order shift due to new page insertion.
genai-tools/code-graph.md nav_order shift due to new page insertion (currently collides with QueryWeaver).
.wordlist.txt Adds new spellcheck allowlist terms (ordering needs adjustment).

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread .wordlist.txt
Comment thread genai-tools/code-graph.md Outdated
galshubeli and others added 2 commits June 3, 2026 14:29
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Copy link
Copy Markdown
Contributor

@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

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In @.wordlist.txt:
- Line 482: The wordlist entry "Markdown" is out of case-insensitive
alphabetical order relative to surrounding entries; move the "Markdown" entry so
it comes after the "MariaDB" entry and after "malte" (i.e., reorder the entries
"malte", "MariaDB", "Markdown") to maintain proper alphabetical sorting of the
list.

In `@genai-tools/code-graph.md`:
- Line 4: Two pages have the same nav_order value causing navigation collisions:
update the front-matter nav_order in genai-tools/code-graph.md (currently
nav_order: 9) or genai-tools/queryweaver.md so every page in the GenAI Tools
section has a unique nav_order; run the provided duplicate-check script to
detect duplicates, then renumber the pages sequentially (adjust the nav_order
field in the offending Markdown files) to ensure each nav_order appears exactly
once.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: b4155793-a2cd-4e21-8d3c-c6b24648009a

📥 Commits

Reviewing files that changed from the base of the PR and between 8fc5ca1 and cc43069.

📒 Files selected for processing (11)
  • .wordlist.txt
  • genai-tools/ag2.md
  • genai-tools/code-graph.md
  • genai-tools/graphrag-server.md
  • genai-tools/graphrag-toolkit.md
  • genai-tools/index.md
  • genai-tools/langchain.md
  • genai-tools/langgraph.md
  • genai-tools/llamaindex.md
  • genai-tools/mcpserver/index.md
  • genai-tools/queryweaver.md

Comment thread .wordlist.txt Outdated
Comment thread genai-tools/code-graph.md Outdated
galshubeli and others added 7 commits June 3, 2026 14:37
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Remove the "Private to your account" feature bullet and the matching
FAQ entry; both asserted data isn't shared with other users, which
doesn't hold given org-level graph storage.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Crop of the graphrag.falkordb.com landing hero, linked to the live
app.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 11 out of 12 changed files in this pull request and generated 3 comments.

Comment thread genai-tools/graphrag-server.md
Comment thread genai-tools/code-graph.md Outdated
Comment thread genai-tools/index.md Outdated
- code-graph: nav_order 9 -> 10 so it no longer collides with
  queryweaver (collision pre-existed on main at 8; now resolved)
- index: link graphrag.falkordb.com and drop em dash in the bullet
- wordlist: order Markdown after MariaDB

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@galshubeli galshubeli merged commit 6eaeb4d into main Jun 3, 2026
6 checks passed
@galshubeli galshubeli deleted the docs/graphrag-server-page branch June 3, 2026 13:04
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.

3 participants