Combine documentation for Quickstart and Running the Code

Question

Combine documentation for Quickstart and Running the Code

Closed this issue a year ago · 1 comments

Currently, the documentation has a Running the Code section and a Quickstart page that is converted automatically from a Jupyter notebook.

Quickstart contains no description of the code beyond a few comments, and Running the Code not only includes the writeup that the Quickstart is (in my opinion) missing, but also references Quickstart in multiple places.

I propose that we combine the two pages by taking the content from Running the Code and adding it to MarkDown cells in Quickstart. An alternative would be to import the Quickstart code into Running the Code, but that seems less natural to me.

Answer 1 · 2023-08-15T17:50:42.000Z

This sounds good to me. I don't see a reason to have the information live in two different places, and a fleshed out quickstart notebook that could just be the example for running the code makes sense.