ProjectPythia / ProjectPythia/cookbook-template
Add Installation in Preamble section
Nobody has claimed this yet.
- Dominant language
- Jupyter Notebook
- Stars
- 25
- Forks
- 29
- Avg merge
- 3d 16h
- Merged PRs (30d)
- 2
Description
Many docs pages include an installation section on the left column.
When I first browsed the cookbooks, I had trouble figuring out how to run the notebook with all the requirements. It turns out it was on the homepage:
https://projectpythia.org/dask-cookbook/README.html#running-on-your-own-machine
Ideally, this would be migrated, or linked, to the left column
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the Preamble section and the cookbook homepage's “Running on Your Own Machine” section at the linked README URL. Move or link the installation guidance into the left column so readers can find the notebook requirements and setup instructions there.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- jupyter-notebook
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100