Skip to content

docs(gfql): show Cypher syntax above the fold in intro pages#976

Merged
lmeyerov merged 2 commits intomasterfrom
docs/gfql-cypher-intro
Mar 30, 2026
Merged

docs(gfql): show Cypher syntax above the fold in intro pages#976
lmeyerov merged 2 commits intomasterfrom
docs/gfql-cypher-intro

Conversation

@lmeyerov
Copy link
Copy Markdown
Contributor

Summary

Both the "10 Minutes to GFQL" and "Overview" pages now lead with Cypher string examples before showing native chain syntax. This makes GFQL immediately approachable for anyone who knows SQL or Cypher.

Changes

  • about.rst: New "Two Syntax Styles" section showing Cypher first, chain second. First two examples show both styles side by side.
  • overview.rst: Quick Examples reordered with Cypher first. Key Concepts updated to mention Cypher strings alongside native chains.

Before

First code a reader sees:

from graphistry import n
people = g.gfql([ n({"type": "person"}) ])._nodes

After

First code a reader sees:

people = g.gfql("MATCH (n {type: 'person'}) RETURN n")._nodes

Test plan

  • Doc example tests pass (21 passed, 7 skipped)
  • RTD preview renders correctly

🤖 Generated with Claude Code

Both about.rst and overview.rst now lead with Cypher string examples
before showing native chain syntax. Clear variable names (nodes_df, g2)
instead of ambiguous ones (people, paths, subgraph).

- about.rst: new "Two Syntax Styles" section, Cypher first in examples
- overview.rst: Quick Examples reordered, Key Concepts updated

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@lmeyerov lmeyerov force-pushed the docs/gfql-cypher-intro branch from 79c0dc9 to ee0ac5f Compare March 30, 2026 05:53
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@lmeyerov lmeyerov merged commit 4c5ad53 into master Mar 30, 2026
33 checks passed
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.

1 participant