From 2c50d9e63a0abe76ad07cc12549791b43051949e Mon Sep 17 00:00:00 2001 From: Vinta Chen Date: Sun, 16 Aug 2026 15:57:31 +0800 Subject: [PATCH] docs: document gitignored output and orphan-key behavior Note that data/github_stars.json is gitignored and fetched by CI at deploy time, so local runs are preview-only and should never be committed; entries removed from README.md just leave harmless orphan keys behind. Co-Authored-By: Claude --- website/fetch_github_stars.py | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/website/fetch_github_stars.py b/website/fetch_github_stars.py index 48aaacf7..3f451885 100644 --- a/website/fetch_github_stars.py +++ b/website/fetch_github_stars.py @@ -1,5 +1,10 @@ #!/usr/bin/env python3 -"""Fetch GitHub star counts and owner info for all GitHub repos in README.md.""" +"""Fetch GitHub star counts and owner info for all GitHub repos in README.md. + +The output file (data/github_stars.json) is gitignored; CI fetches it at +deploy time, so local runs are for previews only — never commit the data. +Entries removed from README.md leave harmless orphan keys behind. +""" import json import os