Skip to content

docs: add db.gds and db.search to quickstart, tutorial, and guide overview#544

Merged
DecisionNerd merged 1 commit into
mainfrom
docs/v040-guide-updates
May 7, 2026
Merged

docs: add db.gds and db.search to quickstart, tutorial, and guide overview#544
DecisionNerd merged 1 commit into
mainfrom
docs/v040-guide-updates

Conversation

@DecisionNerd
Copy link
Copy Markdown
Owner

@DecisionNerd DecisionNerd commented May 7, 2026

Summary

The quickstart, tutorial, and guide overview didn't mention db.gds or db.search at all. This PR adds them.

  • quickstart.md — Graph Algorithms and Hybrid Search sections with minimal working examples
  • tutorial.md — Full db.gds section (PageRank, Louvain, betweenness, algorithm table) and db.search section (text, vector, hybrid, SearchHit → Cypher round-trip)
  • guide/overview.md — Analytics Integration, db.gds, and db.search entries in the Topics list

Test plan

  • mkdocs build --strict clean
  • make pre-push-fast clean

🤖 Generated with Claude Code


View in Codesmith
Need help on this PR? Tag @codesmith with what you need.

  • Let Codesmith autofix CI failures and bot reviews

…rview

- quickstart.md: add Graph Algorithms and Hybrid Search sections with
  minimal working examples before Next Steps
- tutorial.md: add full "Graph Algorithms with db.gds" and "Hybrid Search
  with db.search" sections before Next Steps, covering PageRank/Louvain,
  text/vector/hybrid retrieval, and SearchHit → Cypher round-trip
- guide/overview.md: add Analytics Integration, db.gds, and db.search
  entries to the Topics list with links to tutorial anchors

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 7, 2026

Important

Review skipped

Review was skipped due to path filters

⛔ Files ignored due to path filters (3)
  • docs/getting-started/quickstart.md is excluded by !**/*.md, !**/docs/**
  • docs/getting-started/tutorial.md is excluded by !**/*.md, !**/docs/**
  • docs/guide/overview.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: fb082b42-c9ce-4295-9065-deea347a1b86

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
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/v040-guide-updates

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

@DecisionNerd DecisionNerd merged commit caaffe2 into main May 7, 2026
29 of 30 checks passed
@DecisionNerd DecisionNerd deleted the docs/v040-guide-updates branch May 7, 2026 22:22
@codecov
Copy link
Copy Markdown

codecov Bot commented May 7, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 83.81%. Comparing base (586ff9b) to head (1d104d4).
⚠️ Report is 1 commits behind head on main.
✅ All tests successful. No failed tests found.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #544   +/-   ##
=======================================
  Coverage   83.81%   83.81%           
=======================================
  Files          47       47           
  Lines       12647    12647           
  Branches     3587     3587           
=======================================
  Hits        10600    10600           
  Misses       1265     1265           
  Partials      782      782           
Flag Coverage Δ
full-coverage 83.81% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

Components Coverage Δ
parser 92.93% <ø> (ø)
planner 79.90% <ø> (ø)
executor 75.46% <ø> (ø)
storage 98.68% <ø> (ø)
ast 97.51% <ø> (ø)
types 90.66% <ø> (ø)

Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 586ff9b...1d104d4. Read the comment docs.

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