Skip to content

Documentation Improvement Tasks #352

@gkorland

Description

@gkorland

High Priority

Expand thin command pages

  • Files:
    • commands/graph.query.md — most critical command but lacks TIMEOUT docs, result set description, error handling, write operations
    • commands/graph.info.md — no multi-language examples, no arguments/return section, examples only show empty results
    • commands/graph.explain.md — no sample output showing how to interpret execution plans
  • Action: Expand each page with missing sections, using graph.memory.md as the structural template.

Add multi-language code tabs to inconsistent command pages

  • Files: commands/acl.md, commands/graph.info.md (plain code blocks), commands/graph.memory.md (only shell + JS)
  • Action: Add Python, Java, Rust, and JavaScript examples using code_tabs.html.

Populate empty UDF category index pages

  • Files: udfs/flex/bitwise/index.md, collections/index.md, date/index.md, json/index.md, map/index.md, similarity/index.md, text/index.md
  • Issue: Each contains only a single sentence. Should list available functions and link to child pages.

Fix commands/graph.constraint-drop.md stray frontmatter

  • Issue: Lines 11-16 contain a second YAML-like syntax: block inside the markdown body that renders as broken content.
  • Action: Remove or properly integrate the duplicate block.

Metadata

Metadata

Labels

No labels
No labels

Type

No type
No fields configured for issues without a type.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions