ProjectPythia / ProjectPythia/api-cookbook

Project Pythia Gallery WIP: api-cookbook

Open
#54 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Jupyter Notebook
Stars
2
Forks
9
Avg merge
2d 2h
Merged PRs (30d)
3

Description

Hi @cyschneck @apkrelling @AMDeitsch @hannahzafar, I am reaching out on behalf of the Project Pythia team to unpublished cookbooks. We are looking to expand Project Pythia and we have identified this cookbook as a good candidate for addition to the Project Pythia gallery. Cookbooks do not need to be any particular size or completely finished, just provide the broader community with value. For unfinished cookbooks, we are also introducing a new "Work in Progress" tag that can be updated at any time.

Before publication, this notebook will need updates to:

  • Publication Steps
  • no tagged release
  • placeholder/missing abstract
  • 1 pip dep(s) — prefer conda-forge
  • 1 Sphinx-era package(s) in environment.yml: sphinx-pythia-theme

Unless you have any objections, we are planning to update this cookbook and release it in 4 weeks. We are also happy to help if you would like to complete this cookbook on your own.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the linked Publication Steps issue and inspect the cookbook's environment.yml. Check the publication checklist for the missing abstract, dependency and Sphinx-era package updates, then verify that a tagged release is available and the cookbook meets the gallery requirements.

Written by the indexing model from the issue text.

Assessment

Tech stack
jupyter-notebook
Domain
documentation, release
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Active
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.