dotnet / interactive

.NET Interactive combines the power of .NET with many other languages to create notebooks, REPLs, and embedded coding experiences. Share code, explore data, write, and learn across your apps in ways you couldn't before.
MIT License
2.85k stars 381 forks source link

Lack of documentation and getting started resources. #2792

Open housten opened 1 year ago

housten commented 1 year ago

Describe the bug

The internet had the same few sources and none of them are documentation - just things like blog post announcements from the product group with no links on to documentation. Can we get documentation and/or more example notebooks to show more mini use cases of cross language type interactions (which is what makes polyglot so enticing compared to jupyter). If documentation exists, make it findable. I have been trying to pull together a demo for the team for a few days now but getting a few simple things working is a struggle without documentation and it is tempting to just give up on polyglot till it has stabilized.

For example, Out-Display from the HTML.jpynb in the dotnet interactive repo shows usage under specifying a mime time - and executing it results in errors about no formatters - so where should I go to find info about what out-display can do, and what formatters are included without extensions...

Please complete the following:

Which version of .NET Interactive are you using? (In a notebook, run the #!about magic command. ): .NET Interactive © 2020 Microsoft Corporation Version: 1.0.410202+fce65bd557e21539f9eb0ba3f9c6a64300386c94 Library version: 1.0.0-beta.23102.2+fce65bd557e21539f9eb0ba3f9c6a64300386c94 Build date: 2023-02-21T07:26:56.1402682Z

https://github.com/dotnet/interactive

Screenshots

If applicable, add screenshots to help explain your problem. image

jonsequitur commented 1 year ago

The documentation is outdated here. We're in the process of updating docs and haven't gotten to that one yet, but what we have on formatters is here: https://github.com/dotnet/interactive/blob/main/docs/formatting.md

The Out-Display -MimeType parameter follows the same MIME type rules as described there.

Example MIME types that will work without some additional configuration are text/html, application/json, and text/csv;

jonsequitur commented 1 year ago

Related: #2078