You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Explain model context with README visuals and a shorter tour - #153
Explain how connected tables become model context with a diagram and a 30-second notebook GIF. Shorten the introduction and Quick Tour, move capabilities higher, and link to complete examples instead of embedding the full training script.
Requested improvement: make the README explain relational context quickly. The previous introduction led to a long inline data-generation/training walkthrough; this change adds visual explanations and links to full examples.
File
Function / scope
What changed
Why
README.md
Introduction, navigation and Quick Tour
Add the diagram/GIF, shorten inline setup, move capabilities and tour higher, and format navigation vertically without icons.
Make the first visit easier to understand and scan.
Show tables, connected customer/order records, and bounded historical model context.
Explain the workflow with readable layouts for both screen sizes.
assets/kumo-notebook-demo.gif
Notebook walkthrough
Add a 30-second, 1104×805 scrolling User Flow (~1.27 MiB).
Demonstrate the notebook workflow with a small page payload.
assets/kumo-notebook-demo.png
Static notebook poster
Provide the final schema view for mobile and reduced-motion settings.
Keep the notebook example accessible without autoplay.
Verification: repository documentation checker and diff whitespace checks pass; independent reviews verify decoded GIF duration/size, preserved notebook outputs, code/schema visibility, and browser fallbacks. The PyPI install cell is an unexecuted example; native diagram output comes from the pinned PR #134 development wheel. The diagram is schematic, not an accuracy or attribution claim.
Stopping condition: the requested README presentation is complete; package APIs and runtime behavior are unchanged. Further visual variants are outside this PR.
Reviewing files that changed from the base of the PR and between 791c8d5 and 31fa57f.
Files ignored due to path filters: 4
assets/kumo-notebook-demo.gif is excluded by !**/*.gif
assets/kumo-notebook-demo.png is excluded by !**/*.png
assets/model-context-mobile.svg is excluded by !**/*.svg
assets/model-context.svg is excluded by !**/*.svg
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
No actionable comments were generated in the recent review.
Walkthrough
The README now describes connected-record preparation and time-correct neighborhood retrieval without holding the full graph index in RAM. It adds a customer/order context diagram, capability highlights, and a notebook demo. The Quick Tour links to the package quickstart and hosted walkthroughs. The previous inline synthetic-data and model-training tutorial was removed.
Merge Risk: Minimal · previous review 27aab
The documentation update is mergeable with normal documentation checks.
Pre-merge checks: 2 · 1
Failed checks: 1 inconclusive
Check name
Status
Explanation
Resolution
Change Map Design Review
The required conversation comment beginning with <!-- kumo-pr-change-map --> is not present in the supplied review context or checkout. The PR description links to a change-map issue comment, but th…
Provide the full marked Change map conversation comment, including its linked problem, observed failure, smallest sufficient change, verification, and stopping condition. Then reassess the changed README and assets against that proposal.
Passed checks: 2 passed
Check name
Status
Explanation
Pr Size
The pull request changes 5 files: README.md and four assets. The count does not exceed 40.
Public Resource Access
The pull request adds only local resource references: the two model-context SVGs, the notebook GIF/PNG, and packages/kumo-engine/README.md#quickstart. All targets are present in the PR head, and the…
Full details: Public Resource Access
Explanation
The pull request adds only local resource references: the two model-context SVGs, the notebook GIF/PNG, and packages/kumo-engine/README.md#quickstart. All targets are present in the PR head, and the Quickstart heading matches the anchor. The external URL set is unchanged from the base, so those references are excluded by the check.
Full details: Change Map Design Review
Explanation
The required conversation comment beginning with <!-- kumo-pr-change-map --> is not present in the supplied review context or checkout. The PR description links to a change-map issue comment, but the linked conversation content is unavailable in this run. The design criteria require review of that comment's proposed design and rationale.
Resolution
Provide the full marked Change map conversation comment, including its linked problem, observed failure, smallest sufficient change, verification, and stopping condition. Then reassess the changed README and assets against that proposal.
Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts
Tip
🎯 Customize your risk assessments
Guide how CodeRabbit assesses merge risk and security architecture risk. Highlight sensitive changes and explain your security boundaries using Merge Risk Instructions and Security Risk Instructions in your review settings. Security architecture risk assessments require the Advanced plan or above.
✅ Automatic approvals, with your rules
Let CodeRabbit approve pull requests once required threads are resolved, pre-merge checks pass, and your risk limits are met. Enable Automatic approvals in review settings, with overrides for teams or file paths.
CodeRabbit Verify
Run CodeRabbit Verify to test the changes in this pull request.
Reviewing files that changed from the base of the PR and between ae6c979 and 27aabde.
Files selected for processing: 1
README.md
Included review availability: This review used your included allowance. Your plan provides up to 12 included reviews per hour; 11 remain after this review.
Merges the model-context diagram and notebook walkthrough from #153 with
the problem statement and benchmark proof table from #151.
Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
Keep the problem statement, proof table and requirements line from this PR
alongside the model-context diagram and shorter tour from #153. Drop the
now-redundant 'Benchmark highlight' line and the old accelerator intro.
Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
GitHub Actions
Inactive
Summary
Explain how connected tables become model context with a diagram and a 30-second notebook GIF. Shorten the introduction and Quick Tour, move capabilities higher, and link to complete examples instead of embedding the full training script.
Change map
File-by-file rationale.
Testing Done
Documentation/reference checks and
git diff --checkpass. GIF timing, size, source fidelity, and desktop/mobile/reduced-motion rendering were independently reviewed.