Skip to content

Docs fixes #356

@gkorland

Description

@gkorland

Heading capitalization consistency in datatypes.md

  • Currently: "Scalar types", "Temporal Types", "Collection types" — three different styles.
  • Action: Pick one convention (Title Case or Sentence case).

Fix commands/graph.query.md spelling inconsistency

  • Uses both "Parametrized" and "Parameterized" in the same file.

Fix description casing in commands/graph.copy.md

  • Starts lowercase ("creates a copy"); all other command descriptions start uppercase.

Improve README.md

  • No frontmatter, no project description, no prerequisites, no contribution guidelines.
  • Should be excluded from Jekyll build via _config.yml or given proper content.

Fix index.md minor issues

  • Line 37: OpenCypher link uses http:// instead of https://
  • Line 60: Missing comma after "Once loaded"
  • Line 262: "Mailing List / Forum" heading is misleading for GitHub Discussions link

Algorithm pages consistency

  • Add Performance Considerations and Error Handling sections to all (only BFS has them)
  • Fix recurring "Lets" → "Let's" typo in sppath.md, wcc.md, sspath.md, betweenness-centrality.md
  • Remove trailing colons from headings ("Examples:", "Example:")
  • Verify and unify procedure naming: algo.bfs vs algo.WCC/algo.wcc vs pagerank.stream
  • Fix missing commas in path results in sppath.md and sspath.md

Fix getting-started/configuration.md minor issues

  • Line 320: // comment in shell example should be #
  • "V" and "X" markers in config table are non-standard — use "Yes"/"No" or checkmarks
  • Missing examples for VKEY_MAX_ENTITY_COUNT, CMD_INFO, MAX_INFO_QUERIES

Fix getting-started/clients.md title mismatch

  • Frontmatter title is "Client Libraries" but H1 heading is "Official Clients"

Fix integration/jena.md placeholder issues

  • Port 7474 is Neo4j default, not FalkorDB (should be 6379)
  • Thin content — essentially just links to external repos

Improve cypher/known-limitations.md currency

  • Review whether listed limitations still apply
  • "researching designs" language implies ongoing work with no timeline
  • Add language tags to code blocks

Asymmetric "See Also" cross-references in UDF pages

  • If A links to B, B should link back to A (e.g., jaroWinklerjaccard)

Inconsistent parameter naming in UDF text functions

  • text.indexOf uses offset; text.indexesOf uses from for the same concept

LlamaIndex page: duplicate Resources section

  • Resources appear at both lines 14-18 and 300-305. Consolidate.

LlamaIndex page: potentially broken link

  • gpt-index.readthedocs.io migrated to docs.llamaindex.ai

GraphRAG SDK page improvements

  • No link to GitHub repository
  • "GPT-4.1" model name is unusual — verify accuracy
  • Emoji keycap headings may cause rendering issues

operations/k8s-support.md improvements

  • allowInsecureImages: true needs explanation
  • Sentinel config not actually enabled despite heading claiming it
  • Legacy bitnamilegacy/redis-cluster image may be unmaintained
  • Informal/promotional closing paragraph

operations/migration/kuzu-to-falkordb.md inconsistencies

  • Export defaults to _csv_ but loader defaults to csv_output
  • GitHub links point to different organizations (FalkorDB-POCs vs FalkorDB)

cypher/call.md cleanup

  • Lines 80-129: Large blocks of commented-out HTML should be removed or completed
  • Line 133: "withholding" should be "holding"
  • Code blocks use sh for Cypher

cypher/fulltext-index.md issues

  • Line 458: Description says "enable phonetic search" but example doesn't
  • Fuzzy matching syntax should be verified against RediSearch docs

cypher/range-index.md issues

  • Line 484-486: Uses # comment syntax in Cypher (should be //)

Add version/compatibility info to UDF pages

  • No pages indicate which FalkorDB/FLEX version introduced the functions

Metadata

Metadata

Labels

No labels
No labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions