You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This repo is missing quickstart instructions for the consumer vignettes. For example, the words "Jupyter Notebook" never appear in the README. The user is not told how to install packages they will need to run various notebooks, or how to run the notebooks themselves once they get software installed. Some notebook folders have their own requirements.txt, while others do not. Some consumer vignettes are Markdown files, others are Jupyter notebooks.
The user's experience depends on what vignettes the user starts with and how well they know Python. As is, it would be confusing and difficult to get started, even for someone knowledgeable with Python.
Definition of Done: README file has a quickstart section that explains how to get started and provides some commands that users can copy-and-paste into their terminal. Someone relatively new to Python can start from this repo's README and successfully install/run a notebook without needing to refer to StackOverflow or pick over the source code/Makefiles/YML files in this repo.
The text was updated successfully, but these errors were encountered:
This repo is missing quickstart instructions for the consumer vignettes. For example, the words "Jupyter Notebook" never appear in the README. The user is not told how to install packages they will need to run various notebooks, or how to run the notebooks themselves once they get software installed. Some notebook folders have their own
requirements.txt
, while others do not. Some consumer vignettes are Markdown files, others are Jupyter notebooks.The user's experience depends on what vignettes the user starts with and how well they know Python. As is, it would be confusing and difficult to get started, even for someone knowledgeable with Python.
Definition of Done: README file has a quickstart section that explains how to get started and provides some commands that users can copy-and-paste into their terminal. Someone relatively new to Python can start from this repo's README and successfully install/run a notebook without needing to refer to StackOverflow or pick over the source code/Makefiles/YML files in this repo.
The text was updated successfully, but these errors were encountered: