Skip to content

Refresh README and examples to present petgraph-decypher as a Cypher query/mutation engine#22

Merged
sunsided merged 4 commits into
mainfrom
copilot/update-readme-and-examples
May 10, 2026
Merged

Refresh README and examples to present petgraph-decypher as a Cypher query/mutation engine#22
sunsided merged 4 commits into
mainfrom
copilot/update-readme-and-examples

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented May 10, 2026

  • Review new PR comment and confirm required scope
  • Verify current README wording around Cypher trademark/compatibility language
  • Update README phrasing to use Cypher-compatible wording without endorsement implications
  • Run targeted validation for the documentation-only change
  • Run final review/security validation and reply to the PR comment

Copilot AI changed the title [WIP] Update README and examples for expanded query engine Refresh README and examples to present petgraph-decypher as a Cypher query/mutation engine May 10, 2026
Copilot AI requested a review from sunsided May 10, 2026 07:59
@sunsided sunsided marked this pull request as ready for review May 10, 2026 08:37
Copilot AI review requested due to automatic review settings May 10, 2026 08:37
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR refreshes the public-facing documentation and example code to present petgraph-decypher as a Cypher front-end for petgraph that can build graphs, execute read queries, and apply mutations to existing graphs.

Changes:

  • Reframed README.md from “builder-only” to “build + query + mutate”, including a capability matrix and a limitations/roadmap table.
  • Added README examples demonstrating querying and mutating an existing petgraph::Graph, plus pointers to typed/custom-weight support.
  • Extended examples/indiana_jones.rs to demonstrate cypher_mut (SET), richer projections (DISTINCT, ORDER BY), scalar functions, and OPTIONAL MATCH.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.

File Description
README.md Updates positioning, adds capability/limitations tables, and expands usage examples for querying/mutating existing graphs.
examples/indiana_jones.rs Enhances the example to showcase mutations and richer read-query semantics (functions, distinct/order, optional match).

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread README.md
Comment thread README.md Outdated
Copilot AI requested a review from sunsided May 10, 2026 09:50
@sunsided sunsided merged commit f1cda58 into main May 10, 2026
8 checks passed
@sunsided sunsided deleted the copilot/update-readme-and-examples branch May 10, 2026 10:15
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.

Refresh README and examples around the expanded query engine

3 participants