Skip to content

docs: add Colab badge and notebook gallery#508

Open
mayank-dev-15 wants to merge 1 commit into
dgenio:mainfrom
mayank-dev-15:docs/colab-badges
Open

docs: add Colab badge and notebook gallery#508
mayank-dev-15 wants to merge 1 commit into
dgenio:mainfrom
mayank-dev-15:docs/colab-badges

Conversation

@mayank-dev-15

Copy link
Copy Markdown

Adds "Open in Colab" badge and notebook gallery to README (issue #435).

  • Colab badge in header linking to notebooks/context_rot_live.ipynb
  • Notebook Gallery section with the showcase demo
  • Zero-install way to try contextweaver interactively

Closes #435.

- Added 'Open in Colab' badge to README header
- Added Notebook Gallery section with context_rot_live.ipynb
- Links to Google Colab for zero-install interactive demo

@dgenio dgenio left a comment

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

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

Thanks for this — the badge and gallery table render correctly, and the Colab link points to a real notebook (notebooks/context_rot_live.ipynb) on main, so the change itself is solid and low-risk.

One blocker before merge — the issue linkage:

The description says Closes #435, but #435's acceptance criteria are broader than this PR: four new notebooks mirroring the showcase scenarios, an "Open in Colab" badge on docs/showcase.md, a new notebooks/README.md, and a CI execution gate for the notebooks. Merging this would auto-close #435 with most of that work still undone.

Please change Closes #435Refs #435 (or Part of #435) so the issue stays open to track the remaining notebooks + CI gate. No code changes needed — I'll approve as soon as the linkage reflects the actual scope.

Nit (non-blocking): the header badge and the gallery-row badge both link to the same single notebook. Fine to keep — just flagging the duplication for when the gallery grows.


Generated by Claude Code

dgenio commented Jun 16, 2026

Copy link
Copy Markdown
Owner

Heads up — CI is red on the test (3.12) job, and it's caused by this change:

llms drift detected in: llms-full.txt. Run `make llms` and commit the result.

The repo generates llms-full.txt from sources that include README.md, and the gen_llms.py --check gate (runs in the 3.12 matrix cell) fails because the README edit wasn't accompanied by a regenerated artifact. Quick fix:

  1. make llms
  2. commit the updated llms-full.txt

You can fold this into the same push as the Closes #435Refs #435 linkage change from my review. Once both are in, CI should go green and I'll re-review.


Generated by Claude Code

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.

[Docs] Add "Run in Colab" badges and a notebook gallery for the showcase demos

2 participants