academicpages/academicpages.github.io

Update scripts and notebooks in `markdown_generator`

Open

#3490 opened on Feb 5, 2026

View on GitHub
 (0 comments) (0 reactions) (0 assignees)HTML (16,103 stars) (4,580 forks)batch import
help wanted

Description

Most of the scripts and notebooks in the markdown_generator directory need to reviewed and updated against the following standards:

  1. Python scripts should be checked for correctness against the current template, ideally they should not require additional packages to be installed
  2. Jupyter notebooks should clearly describe what they are doing
  3. Both TSV and CSV files should be supported, but only one example file is needed

Contributor guide

Tech stack
python
Domain
documentationcontent
Issue type
refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
basic Pythonfamiliarity with Jupyter
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70
Research direction
Check all scripts in the `markdown generator` directory for correctness against the current template and ensure they don't require extra packages. Update Jupyter notebooks to clearly describe their purpose. Add support for both TSV and CSV files while keeping only one example file.