Skip to content

Add deployment badges - #288

Merged
krassowski merged 6 commits into
jupyterlab:mainfrom
MUFFANUJ:deploymentLink
Apr 8, 2026
Merged

krassowski merged 6 commits into
jupyterlab:mainfrom
MUFFANUJ:deploymentLink

Conversation

@MUFFANUJ

@MUFFANUJ MUFFANUJ commented Apr 5, 2026

Copy link
Copy Markdown
Member

closes #287

Adds Try it out: deployment badges ( jupyterlite and binder - lab)to each individual example section in README.md:

@MUFFANUJ MUFFANUJ added the documentation Improvements or additions to documentation label Apr 5, 2026
@MUFFANUJ

MUFFANUJ commented Apr 5, 2026

Copy link
Copy Markdown
Member Author

Currently, we’ve included only the Lab links. Adding Notebook links would mean introducing two more links, which may be unnecessary.

@MUFFANUJ MUFFANUJ self-assigned this Apr 5, 2026
@krassowski

Copy link
Copy Markdown
Member

I think we can add links for Notebook for the three extensions which are used to demonstrate dual compatibility:

image

@krassowski

Copy link
Copy Markdown
Member

Should we be adding them in individual per-example README files too? e.g. commands/README.md?

@MUFFANUJ

MUFFANUJ commented Apr 5, 2026

Copy link
Copy Markdown
Member Author

I think we can add links for Notebook for the three extensions which are used to demonstrate dual compatibility:

Sure

@MUFFANUJ

MUFFANUJ commented Apr 5, 2026

Copy link
Copy Markdown
Member Author

The tests failure doesnt seem relevant to our changes, @krassowski please take a look :)

@MUFFANUJ
MUFFANUJ requested a review from krassowski April 5, 2026 18:30
@krassowski krassowski changed the title add deployment badges Add deployment badges Apr 8, 2026

@krassowski krassowski left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Thank you! I will also ask copilot for a pass

Comment thread commands/README.md Outdated

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Pull request overview

Adds “Try it out” deployment badges to make each example runnable directly via the JupyterLab plugin-playground (JupyterLite and/or Binder), improving discoverability and lowering the barrier to experimentation without local setup.

Changes:

  • Added JupyterLite + Binder “Try it out” links to the top-level README.md for each example section (including dual-compatibility examples with Lab/Notebook v7 variants).
  • Added corresponding “Try it out” links to individual example README.md files.
  • Minor formatting update to documents/src/factory.ts, with synced embedme line references in documents/README.md.

Reviewed changes

Copilot reviewed 31 out of 31 changed files in this pull request and generated no comments.

Show a summary per file
File Description
README.md Adds per-example “Try it out” badges (JupyterLite/Binder) across the main examples index, including dual-compatibility tables and Binder-only server example note.
cell-toolbar/README.md Adds “Try it out” badges for the cell-toolbar example.
clap-button-message/README.md Adds “Try it out” table (Lab + Notebook v7) with JupyterLite/Binder links.
codemirror-extension/README.md Adds “Try it out” badges for the CodeMirror extension example.
command-palette/README.md Adds “Try it out” badges for the command palette example.
commands/README.md Adds “Try it out” badges for the commands example.
completer/README.md Adds “Try it out” badges for the completer example.
contentheader/README.md Adds “Try it out” badges for the content header example.
context-menu/README.md Adds “Try it out” badges for the context menu example.
custom-log-console/README.md Adds “Try it out” badges for the custom log console example.
datagrid/README.md Adds “Try it out” badges for the datagrid example.
documents/src/factory.ts Reformats ExampleDocModelFactory declaration (single-line implements), aligning with existing formatting tooling expectations.
documents/README.md Adds “Try it out” badges and updates embedded snippet line references to match the source formatting change.
hello-world/README.md Adds “Try it out” badges for the hello-world example.
kernel-messaging/README.md Adds “Try it out” badges for the kernel-messaging example.
kernel-output/README.md Adds “Try it out” badges for the kernel-output example.
launcher/README.md Adds “Try it out” badges for the launcher example.
log-messages/README.md Adds “Try it out” badges for the log-messages example.
main-menu/README.md Adds “Try it out” badges for the main-menu example.
metadata-form/README.md Adds “Try it out” badges for the metadata-form example.
mimerenderer/README.md Adds “Try it out” badges for the mimerenderer example.
notifications/README.md Adds “Try it out” badges for the notifications example.
react-widget/README.md Adds “Try it out” badges for the react-widget example.
server-extension/README.md Adds Binder “Try it out” link and clarifies JupyterLite is unsupported by design.
settings/README.md Adds “Try it out” badges for the settings example.
shout-button-message/README.md Adds “Try it out” table (Lab + Notebook v7) with JupyterLite/Binder links.
signals/README.md Adds “Try it out” badges for the signals example.
state/README.md Adds “Try it out” badges for the state example.
toolbar-button/README.md Adds “Try it out” badges for the toolbar-button example.
toparea-text-widget/README.md Adds “Try it out” table (Lab + Notebook v7) with JupyterLite/Binder links.
widgets/README.md Adds “Try it out” badges for the widgets example.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@krassowski
krassowski merged commit 6859c1a into jupyterlab:main Apr 8, 2026
89 of 93 checks passed
@github-project-automation github-project-automation Bot moved this from Todo to Done in CFP '25 tracking Apr 8, 2026
@MUFFANUJ
MUFFANUJ deleted the deploymentLink branch April 8, 2026 12:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

Add "Open in plugin playground" links for each extension?

3 participants