Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/521xueweihan/HelloGitHub/llms.txt

Use this file to discover all available pages before exploring further.

HelloGitHub uses two Python scripts to streamline its editorial workflow: make_content.py for regenerating monthly issue Markdown files, and github_bot.py for discovering trending GitHub projects. Together they reduce manual effort — one keeps every published issue in sync when shared boilerplate changes, and the other feeds a daily digest of candidate projects directly to editors’ inboxes.

​
Available Scripts

make_content.py

Regenerates issue content files from a shared template, keeping all monthly issues in sync when common boilerplate changes.

github_bot.py

Discovers trending GitHub projects by monitoring star events from followed accounts, then emails a curated daily digest.

​
Prerequisites

Both scripts require Python 3.x. They live inside the script/ directory of the HelloGitHub repository. Clone the repo and enter it before running either script: 
git clone https://github.com/521xueweihan/HelloGitHub.git
cd HelloGitHub

​
Script Directory Structure

The script/ directory is organised into one sub-folder per script, each containing the script itself and a README.md with usage notes: 
script/
├── make_content/
│   ├── make_content.py
│   └── README.md
└── github_bot/
    ├── github_bot.py
    ├── requirements.txt
    └── README.md
Both scripts must be run from the repository root directory to correctly resolve content paths.

Build docs developers (and LLMs) love

Get started for freeTalk to us