| name | repo-notes-site-curator |
| description | Maintain this repository's bilingual notes section by writing, translating, polishing, or updating paired notes under notes/en and notes/zh, normalizing note front matter, syncing README Notes sections, generating Quarto notes indexes, and validating the website. Use when the user wants to add, translate, improve, or publish a paper-reading or technical-reflection note. |
Repo Notes Site Curator
Update together:
notes/en/**/*.qmd
notes/zh/**/*.qmd
notes/assets/
README.md
README.zh-CN.md
index.qmd
zh/index.qmd
notes/en/index.qmd
notes/zh/index.qmd
Also update _quarto.yml only when the notes render paths or navigation structure need to change.
The generated homepage reads note counts and latest-note dates. Refresh it after notes 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.
Note Structure
Use matching bilingual paths:
notes/en/<topic>/<slug>.qmd
notes/zh/<topic>/<slug>.qmd
Required front matter:
---
author: Brench
date: YYYY-MM-DD
title: "<localized title>"
description: "<localized one-sentence summary>"
order: 1
note_type: paper-reading
topic: <topic>
tags:
- <tag>
---
Allowed note_type values:
paper-reading
technical-reflection
Keep paired English and Chinese notes aligned on date, author, order, note_type, topic, and tags. Titles and descriptions should be localized.
Bilingual Writing and Translation
- When adding, translating, or polishing a note in either language, create or update the matching note in the other language in the same task.
- Preserve the same section structure, technical claims, formulas, links, image order, and conclusions across both versions.
- Write idiomatic localized prose instead of translating sentence by sentence. Keep official paper titles, model names, benchmark names, and established technical terms accurate.
- Localize headings, image alt text, callout labels, descriptions, and surrounding explanations.
- Treat a missing or stale paired translation as incomplete work unless the user explicitly requests a single-language draft.
Asset Rules
- Put shared images under
notes/assets/<slug>/.
- From
notes/<lang>/<topic>/<slug>.qmd, reference shared assets with ../../assets/<slug>/<file>.
- Do not leave per-language duplicate image folders unless the image is language-specific.
Workflow
- Read the source note and identify its topic, slug, language, note type, structure, and main claims.
- Polish the requested language for clear, natural technical writing and Quarto-friendly formatting.
- Create or update the paired note at the same relative path in the other language, preserving content alignment while writing idiomatic localized prose.
- Normalize required front matter in both files.
- Move shared images to
notes/assets/<slug>/ and update image links.
- Check
.codex/project.local.json for conda_env; run Python commands through conda run -n <env> python ....
- Generate README notes sections and notes index pages:
python scripts/sync_notes.py --write
- Refresh generated homepage statistics:
python scripts/check_readme_qmd_sync.py --write
- Validate generated notes content:
python scripts/sync_notes.py
- Validate the paper catalog still ignores notes while keeping homepage stats current:
python scripts/check_readme_qmd_sync.py
- Validate that the Blogs generator still accepts the shared README files:
python scripts/sync_blog_shares.py
- Render the website when requested or when navigation/render configuration changed:
quarto render --no-execute
Output Expectations
- Keep notes separate from the paper catalog.
- Deliver complete English and Chinese note pairs unless the user explicitly requests otherwise.
- Do not hand-edit generated README Notes sections after running the sync script.
- Mention any missing bilingual pair, missing metadata, or failed render clearly.