docs: add GraphRAG Server page for non-expert users#493
Conversation
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>
📝 WalkthroughWalkthroughThis 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. ChangesGraphRAG Server Documentation Addition
🎯 2 (Simple) | ⏱️ ~10 minutes
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
Warning Review ran into problems🔥 ProblemsGit: Failed to clone repository. Please run the 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.
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_orderupdates. - Extended
.wordlist.txtto 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.
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
There was a problem hiding this comment.
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
📒 Files selected for processing (11)
.wordlist.txtgenai-tools/ag2.mdgenai-tools/code-graph.mdgenai-tools/graphrag-server.mdgenai-tools/graphrag-toolkit.mdgenai-tools/index.mdgenai-tools/langchain.mdgenai-tools/langgraph.mdgenai-tools/llamaindex.mdgenai-tools/mcpserver/index.mdgenai-tools/queryweaver.md
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>
- 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>
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
This complements, and is clearly distinguished from, the developer-facing GraphRAG-SDK page (the Python library).
Other changes
genai-tools/index.md)nav_order: 2(right after GraphRAG-SDK) and renumbered the sibling pages; gavecode-grapha uniquenav_order(10) to resolve a pre-existing duplicateexplainabilityandMarkdownto.wordlist.txtfor the spellcheck CIimages/graphrag-server-hero.png(cropped landing-page hero)Verification
pyspelling -c .spellcheck.yml -n Markdown-> Spelling check passedgraphrag-sdk.mdconventions🤖 Generated with Claude Code