You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
docs(readme): make English the default README, keep Chinese as README_CN
- README.md → README_CN.md (Chinese preserved)
- README_EN.md → README.md (English now default)
- Cross-language pointers updated in both files (CN ↔ EN)
- CONTRIBUTING.md + CONTRIBUTING_CN.md: README_EN.md references → README_CN.md
The collection itself remains Chinese-first (each cheat sheet ships with both
中文 and EN HTML); English README is now the landing page so international
readers can navigate the project at a glance.
Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -19,7 +19,7 @@ Every tutorial in this repo was generated by ARIS's `/interview-cheatsheet` + `/
19
19
1.**Install ARIS** (skill source is bundled in `skills/`; canonical home is the [ARIS main repo](https://github.com/wanshuiyin/Auto-claude-code-research-in-sleep)). With Claude Code: `bash <(curl -s https://raw.githubusercontent.com/wanshuiyin/Auto-claude-code-research-in-sleep/main/tools/install_aris.sh)`
20
20
2.**Invoke**`/interview-cheatsheet "<TOPIC>"` from inside this repo. The skill auto-runs the cross-model codex review gate + render-html.
21
21
3.**Review** the generated `.md` / `.html` / `.review.json` files yourself before pushing.
22
-
4.**Open a PR** with all three files (MD source, HTML render, review JSON) plus a row added to README.md / README_EN.md in the right category.
22
+
4.**Open a PR** with all three files (MD source, HTML render, review JSON) plus a row added to README.md / README_CN.md in the right category.
23
23
24
24
If you want to do it by hand without ARIS, that's fine too — just match the structure of an existing tutorial (e.g. `docs/tutorials/attention_tutorial.md`) and run `tools/render_html.py` to render.
25
25
@@ -41,7 +41,7 @@ See `skills/render-html/SKILL.md` and `skills/interview-cheatsheet/SKILL.md` for
41
41
## Pull request process
42
42
43
43
1. Make sure your changes are well-documented (include the `.review.json` so reviewers can see your audit trail).
44
-
2. Update **both**`README.md` and `README_EN.md` if you add a new tutorial — pick the right category bucket (General / Post-Training & Reasoning / LLM Architecture & Systems / Generative Models — Theory & Tokenizers / Generation Systems / Multimodal / Agents).
44
+
2. Update **both**`README.md` and `README_CN.md` if you add a new tutorial — pick the right category bucket (General / Post-Training & Reasoning / LLM Architecture & Systems / Generative Models — Theory & Tokenizers / Generation Systems / Multimodal / Agents).
45
45
3. Keep PRs focused on a single topic — one tutorial per PR.
46
46
4. Clear commit messages — `docs(tutorials): add <Topic> cheat sheet (rendered via /render-html)` is the convention.
47
47
@@ -51,7 +51,7 @@ See `skills/render-html/SKILL.md` and `skills/interview-cheatsheet/SKILL.md` for
51
51
-[ ]`.html` is freshly rendered via `tools/render_html.py`
0 commit comments