docs: add incremental updates API reference and usage guide

[galshubeli]

Summary

• Adds docs/incremental-updates.md documenting the v1.1.0 incremental primitives: update(), delete_document(), apply_changes(), and finalize().
• Each section covers parameters, return shape (UpdateResult / DeleteDocumentResult / ApplyChangesResult / FinalizeResult), and an explicit table of what changes in the graph (chunks, scoped orphan entities, stale RELATES cleanup, no-op short-circuit).
• Documents the update_concurrency=1 invariant and the deletes → updates → adds dispatch order from apply_changes().
• Links the new page from docs/index.md under "Next Steps".

No code changes — docs only.

Test plan

• Render docs/incremental-updates.md and confirm tables/code blocks look right
• Verify all relative links resolve (ingestion.md, storage.md, configuration.md, ../graphrag_sdk/examples/07_incremental_updates.py)
• Spot-check that signatures and return fields match graphrag_sdk/src/graphrag_sdk/api/main.py and core/models.py

🤖 Generated with Claude Code

Summary by CodeRabbit

• Documentation
  • Added comprehensive guide for incremental graph update operations, including API reference, usage examples, and decision guidance for selecting the appropriate method.
  • Updated documentation index with link to new incremental updates guide.

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 1eeeba22-072d-46d9-b1c4-bde965e10577

📥 Commits

Reviewing files that changed from the base of the PR and between a174629 and e24f0dc.

📒 Files selected for processing (2)

• docs/incremental-updates.md
• docs/index.md

---

📝 Walkthrough

Walkthrough

A new comprehensive documentation page describes the v1.1.0 incremental graph update API: update(), delete_document(), apply_changes(), and finalize() primitives with their contracts, return shapes, and concurrency guidance. A navigation link is added to the docs index.

Changes

Incremental Updates Documentation

Layer / File(s)	Summary
Introduction and mental model docs/incremental-updates.md	Introduces incremental updates for graph re-sync and defines the graph element taxonomy, document ownership, and orphan-cleanup scoping rules.
Primitive API contracts docs/incremental-updates.md	Documents update(), delete_document(), apply_changes(), and finalize() with parameter contracts, return field definitions, graph-state scenarios, crash-safety commit points, and concurrency controls.
Decision guidance and examples docs/incremental-updates.md	Provides a decision table for choosing the right primitive, references an end-to-end runnable example, and lists "See Also" documentation links.
Navigation update docs/index.md	Adds "Incremental Updates" link in the "Next Steps" section to direct readers to the new documentation page.

---

🎯 1 (Trivial) | ⏱️ ~5 minutes

---

🐰 Four primitives now shine so bright,
Update, delete, batch, finalize right!
Graph stays in sync, no orphans left behind,
A mental model crystal clear, designed to minds!

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title accurately and concisely describes the main change: adding comprehensive documentation for incremental updates API with reference and usage guidance.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch docs/incremental-updates

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

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