Skip to content

Documentation Improvement Tasks#353

Open
Claude wants to merge 10 commits intomainfrom
claude/improve-documentation-pages
Open

Documentation Improvement Tasks#353
Claude wants to merge 10 commits intomainfrom
claude/improve-documentation-pages

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>Documentation Improvement Tasks</issue_title>
<issue_description>## 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.
    </issue_description>

Comments on the Issue (you are @claude[agent] in this section)

Claude AI and others added 6 commits February 17, 2026 21:32
Co-authored-by: gkorland <753206+gkorland@users.noreply.github.com>
Co-authored-by: gkorland <753206+gkorland@users.noreply.github.com>
…ation

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>
Co-authored-by: gkorland <753206+gkorland@users.noreply.github.com>
@Claude Claude AI changed the title [WIP] Expand command documentation and add code examples Expand documentation for critical commands and populate UDF index pages Feb 17, 2026
@Claude Claude AI requested a review from gkorland February 17, 2026 21:38
@gkorland gkorland marked this pull request as ready for review February 18, 2026 16:29
@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 spelling errors by adding missing words to the wordlist. Commit: 4ee26bd

@Claude Claude AI changed the title Expand documentation for critical commands and populate UDF index pages Addressing PR comments Feb 18, 2026
@gkorland gkorland changed the title Addressing PR comments Documentation Improvement Tasks 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.

Documentation Improvement Tasks

2 participants