Skip to content

docs: add Try It in Google Colab section to README#62

Merged
polaz merged 1 commit intomainfrom
docs/#62-colab-readme
May 3, 2026
Merged

docs: add Try It in Google Colab section to README#62
polaz merged 1 commit intomainfrom
docs/#62-colab-readme

Conversation

@polaz
Copy link
Copy Markdown
Member

@polaz polaz commented May 3, 2026

Adds a table with Open in Colab badges for all 4 demo notebooks, with a note to start from 00 and about the ~8 min first-run build time.

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 3, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro

Run ID: 85d9161f-f7db-435a-9fda-89cc9887190f

📥 Commits

Reviewing files that changed from the base of the PR and between dbbd351 and 5022676.

📒 Files selected for processing (1)
  • README.md

📝 Walkthrough

Summary by CodeRabbit

  • Documentation
    • Added "Try It in Google Colab" section with embedded notebook links to the README
    • Included guidance to start with notebook 00 and engine installation timing information

Walkthrough

README.md enhanced with a "Try It in Google Colab" section containing embedded Colab notebook links for demos (notebooks 00–03), instructions for running the embedded engine in-browser, and timing notes for the embedded install.

Changes

Documentation: Colab Access

Layer / File(s) Summary
Getting Started Documentation
README.md
New "Try It in Google Colab" section (lines 20–33) added with embedded Colab links for notebooks 00–03, usage instructions, and embedded engine install timing guidance.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately describes the main change: adding a 'Try It in Google Colab' section to the README documentation.
Description check ✅ Passed The description is directly related to the changeset, providing details about the Colab section, badges, notebooks, and build time note.
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/#62-colab-readme

Review rate limit: 4/5 reviews remaining, refill in 12 minutes.

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

@sonarqubecloud
Copy link
Copy Markdown

sonarqubecloud Bot commented May 3, 2026

@polaz polaz merged commit 9da6f48 into main May 3, 2026
8 checks passed
@polaz polaz deleted the docs/#62-colab-readme branch May 3, 2026 15:35
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