| name | repo-blog-share-curator |
| description | Maintain this repository's bilingual Blogs section by adding or updating entries in data/blog_shares.json, then generating README.md, README.zh-CN.md, blogs/en/index.qmd, and blogs/zh/index.qmd. Use when the user provides technical blog posts, essays, announcements, or research writeups to share alongside the Awesome LLM Research Collections site. |
Repo Blogs Curator
Update together:
data/blog_shares.json
README.md
README.zh-CN.md
index.qmd
zh/index.qmd
blogs/en/index.qmd
blogs/zh/index.qmd
Also update _quarto.yml only when blog render paths or website navigation change.
The generated homepage reads blog counts and latest-share dates. Refresh it after blog generator writes.
Shared README Stability
README.md and README.zh-CN.md are shared generated surfaces maintained by the paper, notes, and blogs workflows.
- Keep
# Contents / # 目录 ordering stable. Notes entries must remain immediately before Blogs entries.
- When changing a generator, ensure repeated runs are idempotent and do not reorder headings owned by another generator.
- After any command writes either README, run every shared README checker in CI order:
python scripts/sync_notes.py
python scripts/check_readme_qmd_sync.py
python scripts/sync_blog_shares.py
- If a checker reports README drift, run its
--write command, then rerun all shared README checkers from the beginning.
Data Format
Add entries to data/blog_shares.json with these exact fields:
{
"slug": "stable-lowercase-slug",
"date": "YYYY-MM-DD",
"title_en": "Official or English title",
"title_zh": "Localized Chinese title, or official title when better left untranslated",
"description_en": "One concise English summary.",
"description_zh": "一句简洁中文简介。",
"blog_url": "https://example.com/post",
"github_url": ""
}
Rules:
- Sort is generated by
date descending; do not hand-sort generated README sections.
blog_url is required.
github_url is optional. Leave it empty when no official repository is linked by the blog.
- Keep summaries concise and source-grounded.
Workflow
- Verify the blog title, date, description, canonical blog URL, and any official GitHub URL.
- Add or update the matching entry in
data/blog_shares.json.
- Check
.codex/project.local.json for conda_env; run Python commands through conda run -n <env> python ....
- Generate README sections and blog index pages:
python scripts/sync_blog_shares.py --write
- Refresh generated homepage statistics:
python scripts/check_readme_qmd_sync.py --write
- Validate generated blog content:
python scripts/sync_blog_shares.py
- Validate the paper catalog still ignores blog sections while keeping homepage stats current:
python scripts/check_readme_qmd_sync.py
- Render the website when navigation, render paths, or generated pages changed:
quarto render --no-execute
Output Expectations
- Keep Blogs separate from papers and notes.
- Do not hand-edit generated Blogs sections after running the sync script.
- Mention missing dates, ambiguous canonical URLs, unavailable GitHub links, or failed render clearly.