Skip to content

Docs fixes#355

Open
Claude wants to merge 7 commits intomainfrom
claude/update-docs-references-and-python
Open

Docs fixes#355
Claude wants to merge 7 commits intomainfrom
claude/update-docs-references-and-python

Conversation

@Claude
Copy link
Contributor

@Claude Claude AI commented Feb 17, 2026

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...

Claude AI and others added 3 commits February 17, 2026 21:35
Co-authored-by: gkorland <753206+gkorland@users.noreply.github.com>
Co-authored-by: gkorland <753206+gkorland@users.noreply.github.com>
Co-authored-by: gkorland <753206+gkorland@users.noreply.github.com>
@Claude 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 Claude AI requested a review from gkorland February 17, 2026 21:40
@gkorland gkorland marked this pull request as ready for review February 18, 2026 17:00
@gkorland
Copy link
Contributor

@claude[agent] please fix the spelling error

Co-authored-by: gkorland <753206+gkorland@users.noreply.github.com>
@Claude
Copy link
Contributor Author

Claude AI commented Feb 18, 2026

@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.

@Claude Claude AI changed the title Fix outdated references, terminology, Python versions, and structural issues across documentation Addressing PR comments Feb 18, 2026
@gkorland gkorland changed the title Addressing PR comments Docs fixes Feb 24, 2026
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.

Docs fixes

2 participants