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 <noreply@anthropic.com>
This commit is contained in:
Vinta Chen
2026-08-16 15:57:31 +08:00
co-authored by Claude
parent deae0e0b72
commit 2c50d9e63a
+6 -1
View File
@@ -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