Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Initial documentation of the Kernel protocol #1

Merged
merged 1 commit into from
Jun 12, 2023

Conversation

JohanMabille
Copy link
Member

@JohanMabille JohanMabille commented Apr 21, 2023

This is more or less the documentation that we currently have in jupyter_client.

I need to setup the readthedocs project so that it can be built. In the meantime, any feedback is welcome.

@Zsailer
Copy link
Member

Zsailer commented Apr 24, 2023

Thank you @JohanMabille! I think it's a good idea to separate the protocol from jupyter_client documentation.

That said, we should carefully consider how we can redirect folks from those old documentation pages to these new pages. The jupyter_client repo has been around awhile, and I'd bet there are many places on the internet where those old pages are referenced. We should do our best not to break those links...

@Zsailer
Copy link
Member

Zsailer commented Apr 24, 2023

That said, we should carefully consider how we can redirect folks from those old documentation pages to these new pages. The jupyter_client repo has been around awhile, and I'd bet there are many places on the internet where those old pages are referenced. We should do our best not to break those links...

I don't think this should block us from merging this PR. Let's keep this as a follow-up action item.

@JohanMabille JohanMabille merged commit ea6f3c8 into main Jun 12, 2023
@JohanMabille JohanMabille deleted the initial_documentation branch June 12, 2023 19:43
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.

2 participants