Skip to content

docs(architecture): scope Arrow result contract to data-returning operations - #713

Merged
DecisionNerd merged 1 commit into
mainfrom
docs/708-arrow-result-contract-scope
Aug 14, 2026
Merged

DecisionNerd merged 1 commit into
mainfrom
docs/708-arrow-result-contract-scope

Conversation

@DecisionNerd

@DecisionNerd DecisionNerd commented Aug 14, 2026 •

Copy link
Copy Markdown
Contributor

Summary

  • Replace the universal Arrow-return claim in architecture overview with a data-plane vs control/construction-plane contract, including an inventory of intentional non-Arrow returns (labels, node_count, explain, lifecycle (), construction handles).
  • Reconcile API reference, guides, contributor/engineering docs, and AGENTS.md so they no longer imply every method returns Arrow or that bindings own tabular reconstruction.
  • Keep Cypher and analyst/data-bearing Arrow guarantees strong; no runtime API changes.

Test plan

  • Search docs for contradictory universal claims (all methods return Arrow, bespoke result type, Unified result contract) — clean
  • Cross-check overview inventory against Rust (labels/node_count/explain/add_node) and Python/Node projections
  • Docs CI / documentation checks on PR head

Closes #708

Made with Cursor


View with [code]smith Autofix with [code]smith
Need help on this PR? Tag @codesmith-bot with what you need. Autofix is disabled.

Replace the false universal "all methods return Arrow" claim with a precise
data-plane vs control/construction-plane contract, and reconcile API, guide,
and contributor docs so signatures match (Closes #708).

Co-authored-by: Cursor <cursoragent@cursor.com>
@github-actions github-actions Bot added documentation Improvements or additions to documentation release:none No release note or version impact labels Aug 14, 2026
@coderabbitai

coderabbitai Bot commented Aug 14, 2026

Copy link
Copy Markdown

Important

Review skipped

Review was skipped due to path filters

⛔ Files ignored due to path filters (11)
  • AGENTS.md is excluded by !**/*.md
  • docs/book/architecture/execution-model.md is excluded by !**/*.md, !**/docs/**
  • docs/book/architecture/overview.md is excluded by !**/*.md, !**/docs/**
  • docs/book/architecture/refactor-v0.5.md is excluded by !**/*.md, !**/docs/**
  • docs/development/contributing.md is excluded by !**/*.md, !**/docs/**
  • docs/engineering/ARCHITECTURE.md is excluded by !**/*.md, !**/docs/**
  • docs/guide/graph-construction.md is excluded by !**/*.md, !**/docs/**
  • docs/guide/overview.md is excluded by !**/*.md, !**/docs/**
  • docs/guide/visualization.md is excluded by !**/*.md, !**/docs/**
  • docs/index.md is excluded by !**/*.md, !**/docs/**
  • docs/reference/api.md is excluded by !**/*.md, !**/docs/**

CodeRabbit blocks several paths by default. You can override this behavior by explicitly including those paths in the path filters. For example, including **/dist/** will override the default block on the dist directory, by removing the pattern from both the lists.

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: c2a6fe91-cf85-433a-9fa8-91694e3e49b0

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review

Comment @coderabbitai help to get the list of available commands.

@DecisionNerd
DecisionNerd merged commit 3629989 into main Aug 14, 2026
21 checks passed
@DecisionNerd
DecisionNerd deleted the docs/708-arrow-result-contract-scope branch September 17, 2026 18:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation release:none No release note or version impact

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs(architecture): scope the Arrow result contract to data-returning operations

1 participant