Docs fixes by Claude · Pull Request #355 · FalkorDB/docs

Claude · 2026-02-17T21:32:35Z

Original prompt

This section details on the original issue you should resolve

<issue_title>Docs fixes</issue_title>
<issue_description>

Outdated references to RedisGraph and Redis tooling

Files:
- design/client-spec.md — references "RedisGraph v2.1.0", links to deprecated redisgraph-py repo
- design/third-party.md — RedisGraph/Redis licensing may be outdated
- getting-started/clients.md — many "Additional Clients" reference RedisGraph projects with no compatibility note
- commands/index.md — "within Redis" phrasing may be misleading
- operations/k8s-support.md — uses "master and slave" terminology
Action: Update terminology, add compatibility notes, fix links.

Update EOL Python version requirements

Files: operations/migration/kuzu-to-falkordb.md (Python 3.6+), operations/migration/neo4j-to-falkordb.md (Python 3.6+), operations/opentelemetry.md (Python 3.8+)
Action: Update to currently supported Python version (3.9+ minimum).

Fix `_config.yml` issues

Missing url key for canonical URL generation
Missing exclude list (README.md, Gemfile, etc. will be built into the site)
Unpinned remote_theme version
Protocol-relative URLs (//github.com/...) should use https://
Consider adding jekyll-seo-tag plugin
Ruby docs link references EOL Ruby 2.7

Standardize command page structure

Issue: Inconsistent formatting across command pages — some use headings for Arguments/Returns, some use inline text, some use <details> HTML.
Action: Adopt graph.memory.md structure (Syntax, Arguments, Return, Examples) as template for all command pages.

Standardize shell prompt style in examples

Issue: Varies between 127.0.0.1:6379>, redis>, >, and no prompt.
Action: Pick one convention and apply it consistently.

Fix inconsistent code example completeness

Issue: Some command examples show full imports/client setup, others show only the call.
Files: graph.query.md, graph.ro-query.md (no setup) vs graph.list.md, graph.config-set.md (full setup)
Action: Make all examples copy-paste ready with setup code.

De-duplicate Rust Loader content in migration guides

Files: operations/migration/kuzu-to-falkordb.md, operations/migration/neo4j-to-falkordb.md
Issue: The FalkorDB-Loader-RS section is nearly identical in both files.
Action: Extract to a shared page and reference from both.

De-duplicate content in `agentic-memory/cognee.md`

Issue: LLM config appears twice, database config appears twice, "Managing Knowledge" duplicates "Adding Multiple Documents".
Action: Consolidate to reduce page length by ~30%.

Reconcile cloud pricing tables

Files: cloud/free-tier.md, cloud/startup-tier.md, cloud/enterprise-tier.md
Issues: Discrepancies in Azure/BYOC notation, last-row labels ("Call-to-Action" vs "Get started"), feature highlighting
Action: Unify table content across all tier pages.

Fix `cloud/free-tier.md` heading level

Issue: Uses #### Terms (H4) while all other tier pages use ## Terms (H2).

Fix `cloud/features.md` hierarchy

Issue: "Solution Architecture" incorrectly nested under "Graph Browser" as H3. Should be its own H2.
Issue: Missing docs for Graph Access Control, Cluster Deployment, HA, Multi-zone, Automated Backups, Advanced Monitoring.

Expand `commands/index.md` landing page

Issue: Very short, does not list or link to any child command pages.
Action: Add a table or list of all available commands with brief descriptions.

Fix `design/client-spec.md` outdated claims

Line 192: "each node can have either 0 or 1 labels" — multi-label is now supported
Lines 38-40: Links to specific commit hash for enum definitions — will drift
Action: Update content to reflect current capabilities.

Add missing `redirect_from` in Cypher section

Files: call.md, foreach.md, merge.md, skip.md, limit.md, remove.md, match.md, procedures.md, set.md, unwind.md, where.md, with.md

Expand thin Cypher pages

Files: cypher/skip.md, cypher/limit.md, cypher/order-by.md
Action: Add edge-case docs (SKIP beyond total records, LIMIT without ORDER BY, NULL sort ordering), cross-references, and complete query examples.

Add missing Go and C# to getting-started installation tabs

File: getting-started/index.md
Issue: Both are official clients but missing from the tabbed examples.

Fix `udfs/index.md` structural issues

Line 274: falkor.register heading is H5 instead of H4
Line 251-253: Misplaced paragraph about multi-source traversal
Line 394: Grammar — missing comma and conjunction

Fix `operations/opentelemetry.md` scope and accuracy

Title doesn't indicate Python-only focus
RedisInstrumentor imported but never used
Jaeger exporter is deprecated — should note OTLP alternative
Only covers traces despite c...

Fixes Docs fixes #354

Co-authored-by: gkorland <753206+gkorland@users.noreply.github.com>

gkorland · 2026-02-18T17:00:32Z

@claude[agent] please fix the spelling error

Co-authored-by: gkorland <753206+gkorland@users.noreply.github.com>

Claude · 2026-02-18T17:02:17Z

@claude[agent] please fix the spelling error

Fixed in 95cad33. Changed "This file specify" to "This file specifies" and "and configure" to "and configures" in operations/k8s-support.md.

Merge main into PR branch, resolving conflicts in: - cloud/features.md: keep blank line after Solution Architecture heading - cloud/free-tier.md: keep H2 Terms heading to match other tier pages - design/client-spec.md: accept main's two-line formatting - operations/opentelemetry.md: use concise 'Python 3.9+' phrasing - udfs/index.md: keep falkor description paragraph, keep grammar fix Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Removed sections on Graph Access Control, Cluster Deployment, High Availability, Multi-zone Deployment, Automated Backups, and Advanced Monitoring due to pending documentation.

Copilot

Pull request overview

This PR updates FalkorDB documentation to remove outdated RedisGraph/Redis-era references, improve site configuration, and add missing redirects and content structure fixes across docs pages.

Changes:

Refresh terminology and references (RedisGraph → FalkorDB) and add compatibility guidance for legacy clients.
Improve docs site config (canonical url, pinned theme version, SEO plugin, excludes, https links).
Add redirect_from entries for multiple Cypher clause pages and fix minor doc structure/wording issues.

Reviewed changes

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

Show a summary per file

File	Description
udfs/index.md	Minor wording/grammar fix in UDF example explanation.
operations/opentelemetry.md	Clarifies Python tracing scope in page description/intro.
getting-started/clients.md	Adds support/compatibility note for RedisGraph-origin “Additional Clients”.
design/third-party.md	Reworks RedisGraph/Redis/RediSearch references into a historical attribution section.
design/client-spec.md	Updates enum links away from pinned commit; replaces RedisGraph references and corrects label semantics.
cypher/call.md	Adds missing `redirect_from` entries.
cypher/foreach.md	Adds missing `redirect_from` entries.
cypher/limit.md	Adds missing `redirect_from` entries.
cypher/match.md	Adds missing `redirect_from` entries.
cypher/merge.md	Adds missing `redirect_from` entries.
cypher/procedures.md	Adds missing `redirect_from` entries.
cypher/remove.md	Adds missing `redirect_from` entries.
cypher/set.md	Adds missing `redirect_from` entries.
cypher/skip.md	Adds missing `redirect_from` entries.
cypher/unwind.md	Adds missing `redirect_from` entries.
cypher/where.md	Adds missing `redirect_from` entries.
cypher/with.md	Adds missing `redirect_from` entries.
commands/index.md	Adjusts wording to avoid “within Redis” phrasing.
cloud/free-tier.md	Fixes heading level for “Terms” section.
cloud/features.md	Adds new feature headings for missing topics (currently placeholders).
_config.yml	Pins theme version, adds canonical `url`, SEO plugin, excludes, and https aux links.
.wordlist.txt	Adds “foreach” to spellcheck wordlist.

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

Copilot · 2026-03-22T07:03:33Z

design/client-spec.md

+[ColumnType](https://github.com/FalkorDB/FalkorDB/blob/master/src/resultset/formatters/resultset_formatter.h) enum, which as of v2.1.0 will always be `COLUMN_SCALAR`. This enum is retained for backwards compatibility, and may be ignored by the client unless versions older than v2.1.0 must be supported.

-[ValueType](https://github.com/FalkorDB/FalkorDB/blob/ff108d7e21061025166a35d29be1a1cb5bac6d55/src/resultset/formatters/resultset_formatter.h#L21-L28) indicates the data type (such as Node, integer, or string) of each returned value. Each value is emitted as a 2-array, with this enum in the first position and the actual value in the second. Each property on a graph entity also has a scalar as its value, so this construction is nested in each value of the properties array when a column contains a node or relationship.
+[ValueType](https://github.com/FalkorDB/FalkorDB/blob/master/src/resultset/formatters/resultset_formatter.h) enum indicates the data type (such as Node, integer, or string) of each returned value. Each value is emitted as a 2-array, with this enum in the first position and the actual value in the second. Each property on a graph entity also has a scalar as its value, so this construction is nested in each value of the properties array when a column contains a node or relationship.


In this sentence, “as of v2.1.0” is ambiguous (v2.1.0 of what?) and later in the doc you use “FalkorDB v2.1.0”. Consider making this consistent by naming the product/version here as well (e.g., “as of FalkorDB v2.1.0”).

Copilot · 2026-03-22T07:03:34Z

design/third-party.md

+
+## Historical Attribution
+
+FalkorDB is built upon technology originally developed as RedisGraph (licensed under RSALv2/SSPLv1) and Redis (licensed under RSALv2/SSPLv1), and RediSearch (licensed under RSALv2/SSPLv1). FalkorDB continues to evolve these technologies under an open-source model.


The new “Historical Attribution” paragraph mentions RSALv2/SSPLv1 but no longer links to the license texts (the previous numbered entries did). To keep this section verifiable and avoid ambiguity, add links to the referenced licenses (and/or the relevant upstream repos’ LICENSE files) in this paragraph.

Suggested change

FalkorDB is built upon technology originally developed as RedisGraph (licensed under RSALv2/SSPLv1) and Redis (licensed under RSALv2/SSPLv1), and RediSearch (licensed under RSALv2/SSPLv1). FalkorDB continues to evolve these technologies under an open-source model.

FalkorDB is built upon technology originally developed as [RedisGraph](https://github.com/RedisGraph/RedisGraph) (licensed under the [Redis Source Available License v2 (RSALv2)](https://redis.com/legal/rsalv2-agreement/) / [Server Side Public License v1 (SSPLv1)](https://www.mongodb.com/licensing/server-side-public-license)), [Redis](https://github.com/redis/redis) (licensed under RSALv2/SSPLv1), and [RediSearch](https://github.com/RediSearch/RediSearch) (licensed under RSALv2/SSPLv1). FalkorDB continues to evolve these technologies under an open-source model.

design/third-party.md

Remove redirect_from front matter added to 12 cypher pages: call, foreach, limit, match, merge, procedures, remove, set, skip, unwind, where, with. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

There is a newer version available than v0.10.0, so revert to unpinned remote_theme to pick it up automatically. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Revert the Historical Attribution rewrite and restore the original RedisGraph, Redis, and RediSearch entries. Add AGPLv3 as an additional license option for all three. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Restore original commit hash links with line anchors and redisgraph-py example references. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Initial plan

5e58169

Claude AI assigned Claude and gkorland Feb 17, 2026

Claude started work on behalf of gkorland February 17, 2026 21:32 View session

Claude AI and others added 3 commits February 17, 2026 21:35

Fix config, RedisGraph references, terminology, and Python versions

0cc3653

Co-authored-by: gkorland <753206+gkorland@users.noreply.github.com>

Fix client compatibility notes, cloud docs, and UDF structural issues

07523aa

Co-authored-by: gkorland <753206+gkorland@users.noreply.github.com>

Add redirect_from to Cypher documentation pages

7d7a024

Co-authored-by: gkorland <753206+gkorland@users.noreply.github.com>

Claude AI changed the title ~~[WIP] Fix outdated references and Python version requirements~~ Fix outdated references, terminology, Python versions, and structural issues across documentation Feb 17, 2026

Claude AI requested a review from gkorland February 17, 2026 21:40

Claude finished work on behalf of gkorland February 17, 2026 21:40

Merge branch 'main' into claude/update-docs-references-and-python

ec19a11

gkorland marked this pull request as ready for review February 18, 2026 17:00

Claude started work on behalf of gkorland February 18, 2026 17:01 View session

Fix spelling errors in k8s-support.md

95cad33

Co-authored-by: gkorland <753206+gkorland@users.noreply.github.com>

Claude AI changed the title ~~Fix outdated references, terminology, Python versions, and structural issues across documentation~~ Addressing PR comments Feb 18, 2026

Claude finished work on behalf of gkorland February 18, 2026 17:03

gkorland changed the title ~~Addressing PR comments~~ Docs fixes Feb 24, 2026

gkorland and others added 3 commits February 24, 2026 13:28

Merge branch 'main' into claude/update-docs-references-and-python

77444f5

fix(spellcheck): add lowercase 'foreach' to wordlist

a1afc30

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

gkorland requested a review from Copilot March 22, 2026 07:01

Copilot started reviewing on behalf of gkorland March 22, 2026 07:01 View session

Remove pending documentation sections from features.md

a39e575

Removed sections on Graph Access Control, Cluster Deployment, High Availability, Multi-zone Deployment, Automated Backups, and Advanced Monitoring due to pending documentation.

Copilot AI reviewed Mar 22, 2026

View reviewed changes

gkorland and others added 4 commits March 22, 2026 09:05

docs(cypher): remove redirect_from blocks from cypher pages

5434396

Remove redirect_from front matter added to 12 cypher pages: call, foreach, limit, match, merge, procedures, remove, set, skip, unwind, where, with. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Apply suggestion from @Copilot

85928fd

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

fix(config): revert pinned theme version to use latest

4810753

There is a newer version available than v0.10.0, so revert to unpinned remote_theme to pick it up automatically. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

gkorland and others added 3 commits March 22, 2026 09:38

fix(spellcheck): add AGPLv3 to wordlist

2bcf6c0

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

fix(spellcheck): add AGPLv to wordlist

7d3c250

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

docs(client-spec): revert GitHub code link changes

239542a

Restore original commit hash links with line anchors and redisgraph-py example references. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

gkorland approved these changes Mar 22, 2026

View reviewed changes

gkorland merged commit df21552 into main Mar 22, 2026
3 checks passed

gkorland deleted the claude/update-docs-references-and-python branch March 22, 2026 07:58

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Docs fixes#355

Docs fixes#355
gkorland merged 17 commits intomainfrom
claude/update-docs-references-and-python

Claude AI commented Feb 17, 2026 •

edited

Loading

Uh oh!

gkorland commented Feb 18, 2026

Uh oh!

Claude AI commented Feb 18, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Mar 22, 2026

Uh oh!

Copilot AI Mar 22, 2026

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants


		## Historical Attribution

		FalkorDB is built upon technology originally developed as RedisGraph (licensed under RSALv2/SSPLv1) and Redis (licensed under RSALv2/SSPLv1), and RediSearch (licensed under RSALv2/SSPLv1). FalkorDB continues to evolve these technologies under an open-source model.

Conversation

Claude AI commented Feb 17, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Outdated references to RedisGraph and Redis tooling

Update EOL Python version requirements

Fix _config.yml issues

Standardize command page structure

Standardize shell prompt style in examples

Fix inconsistent code example completeness

De-duplicate Rust Loader content in migration guides

De-duplicate content in agentic-memory/cognee.md

Reconcile cloud pricing tables

Fix cloud/free-tier.md heading level

Fix cloud/features.md hierarchy

Expand commands/index.md landing page

Fix design/client-spec.md outdated claims

Add missing redirect_from in Cypher section

Expand thin Cypher pages

Add missing Go and C# to getting-started installation tabs

Fix udfs/index.md structural issues

Fix operations/opentelemetry.md scope and accuracy

Uh oh!

gkorland commented Feb 18, 2026

Uh oh!

Claude AI commented Feb 18, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Mar 22, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 22, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Claude AI commented Feb 17, 2026 •

edited

Loading

Fix `_config.yml` issues

De-duplicate content in `agentic-memory/cognee.md`

Fix `cloud/free-tier.md` heading level

Fix `cloud/features.md` hierarchy

Expand `commands/index.md` landing page

Fix `design/client-spec.md` outdated claims

Add missing `redirect_from` in Cypher section

Fix `udfs/index.md` structural issues

Fix `operations/opentelemetry.md` scope and accuracy