jupyter / jupyter/notebook

Document the notebook kernel websocket message spec

Open
#3,758 1 comment 0 reactions 0 assignees View on GitHub
Dominant language
Jupyter Notebook
Stars
13.3k
Forks
5.8k
Avg merge
6d 11h
Merged PRs (30d)
7

Description

The messages coming on a websocket connection to the kernel bridge are slightly different than the plain kernel message spec. We should document these differences for notebook server clients.

For example:

1. Messages have a `channel` top-level field to indicate what channel the messages are coming from.
2. The notebook itself sends some messages, like kernel restarting messages.
3. The websocket wire format should be documented.

I'm sure there are more differences.

CC @minrk

Contributor guide

Open the contributing guide

Research direction

Start by comparing the websocket kernel bridge messages with the plain kernel message specification. Document the top-level channel field, notebook-originated messages such as kernel restarting messages, and the websocket wire format; done means the differences relevant to notebook server clients are covered.

Written by the indexing model from the issue text.

Assessment

Tech stack
jupyter-notebook
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.