docs: expose runnable Binder and Colab paths - #83
Conversation
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 0fa6b5028b
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
| The [Binder](https://mybinder.org/v2/gh/dnncha/dotmatch/main?labpath=demo.ipynb) | ||
| and [Colab](https://colab.research.google.com/github/dnncha/dotmatch/blob/main/demo.ipynb) | ||
| notebooks run a small synthetic smoke demo without requiring a local install. |
There was a problem hiding this comment.
When a user follows this Colab link, Colab loads the notebook but does not check out the surrounding repository. The setup cell in demo.ipynb searches the runtime working directory and its parents for demo-data/crispr_guides.tsv, so a standard /content runtime raises FileNotFoundError before the demo runs; the local dotmatch package would also be unavailable. Add a Colab bootstrap step that clones/installs the repository and selects its directory, or link to a notebook that includes such a step.
Useful? React with 👍 / 👎.
1 participant
Summary
demo.ipynbthrough Binder and Google Colab from the main READMEThis is intentionally a one-file discoverability change. The notebook and its small public fixture already exist on
main; no package code or release artifact changes.