Notebook docs

[JacksonKearl]

Ref #3784

[rebornix]

Good work and I like the flow a lot ❤️ . Only a couple of suggestions.

[rebornix]

We may also want to talk about multi-mimetype output and how extensions and users can control the display order of multi-mimetype output.

[JacksonKearl]

I gave an example above with

{
	outputKind: vscode.CellOutputKind.Rich,
	data: {
		'text/html': '<b>Hello</b> World',
		'application/json': { hello: 'world' },
		'application/hello-world': 'my-hello-world-data-interchange-format',
	}
}

is that what you mean by multi-mimetype output?

And how can extensions and users can control the display order of multi-mimetype output?

[rebornix]

Yes, that's a multi-mimetype output. Firstly, we have builtin display orders

https://github.com/microsoft/vscode/blob/d8ef78152ce82d2e821ae2ef85ca08a54f89fa84/src/vs/workbench/contrib/notebook/common/notebookCommon.ts#L33-L53

and both notebook content providers

https://github.com/microsoft/vscode/blob/6ff3cb7ca2dfa93988aa44cadd97b8e4db25c69b/src/vs/vscode.proposed.d.ts#L1474

and users ("notebook.displayOrder": []) can control that. Also, users settings > document metadata > builtin orders.

[roblourens]

Minor point but it sounds like maybe we should be using mediaType or contentType instead of mimeType which might be an outdated term.

[roblourens]

In the actual API I mean

[JacksonKearl]

@roblourens that makes sense to me. Maybe open an issue in vscode?

[roblourens]

I think any kernel would be tied to a programming language. A provider might not be (markdown notebook etc) but I think any kernel would execute something right?

[JacksonKearl]

I have some that execute HTTP requests..

[roblourens]

Oh good point

[JacksonKearl]

cc @gregvanl or @ornellaalt :)

[rebornix]

Minor point but it sounds like maybe we should be using mediaType or contentType instead of mimeType which might be an outdated term.

@roblourens @JacksonKearl I'm wondering if mimeType is a correct/better term here, which represents type/subType but without parameters (e.g., text/html; charset=UTF-8). Also mimeType is used in Jupyter notebook and VS Code code base (Language Defintion, Emmet, Git)

[roblourens]

Ok I guess we should stick with it if that's what is typically used