Commit 8d91f09
docs(readme): rebuild both editions, correct the Transparent Title name (T-053)
Rebuilt from the maintainer's drafted bilingual pair, corrected against the
repository. The draft was accurate on features (every claim checked against
the code, including Dissolve / Flatten All, collision auto-numbering, and the
group gestures) but wrong on three points:
- It dropped credits for the four referenced open-source projects, the
third-party license pointers, the developer-doc index, the CHANGELOG and
ROADMAP links, the settings section, and the maintainer's own note about
delayed replies. Credits and license pointers are an attribution
obligation, so all of it is restored.
- It listed WK Groups as a fourth sidebar tab beside the three real ones.
Groups are a canvas feature, and the content audit forbids presenting an
optional or compatible tab as a fixed fourth built-in.
- It used the new Chinese product name before that rename was decided. That
matched intent, so the branding doc moved to the draft rather than back.
Correct a long-standing factual error found while placing the new cover: both
READMEs called the annotation node "Title2", but its display name in ComfyUI's
menu is "Transparent Title(透明标题)" under the WorkspaceKit category. A
reader following the README would look for a menu entry that does not exist.
Both sections are renamed and now state where to find it.
English stays the default README. Making Chinese the default was implemented
and then reversed on request, because pyproject's `readme` field ships
README.md as the Comfy Registry description, and a Chinese listing does not
serve a mostly international audience.
That round trip exposed a real coupling: release_version.py reads both
READMEs by filename and rewrites the release-status line in each, so swapping
languages between filenames breaks `--check` immediately. Observed in both
directions. The new contract pins the mapping so a future swap fails in the
test suite instead of at release time.
Drop the five archived screenshot references and place the six covers and
three GIFs. Because real GIFs now ship, remove the "GIF tutorials are still
being prepared" limitation from both editions.
Add scripts/test-readme-surface.mjs, pinning each file's language, the release
script's filename mapping, that every local image and link target resolves,
the assigned covers and GIFs, the audit's fact boundaries, the archive rule,
the node display name against __init__.py, and the absence of the retired
Chinese and English product labels across all six renamed surfaces.
Verified: 9 images per edition with 0 broken targets, 5 in-page anchors each
with 0 missing, suite 89 JS / 6 Python, release check green.
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>1 parent 33be2cf commit 8d91f09
6 files changed
Lines changed: 634 additions & 200 deletions
Large diffs are not rendered by default.
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
1 | | - | |
| 1 | + | |
2 | 2 | | |
3 | 3 | | |
4 | 4 | | |
5 | 5 | | |
6 | 6 | | |
7 | | - | |
| 7 | + | |
8 | 8 | | |
9 | 9 | | |
10 | 10 | | |
11 | 11 | | |
12 | 12 | | |
13 | | - | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
14 | 16 | | |
15 | 17 | | |
16 | 18 | | |
| 19 | + | |
| 20 | + | |
17 | 21 | | |
18 | 22 | | |
19 | | - | |
| 23 | + | |
20 | 24 | | |
21 | 25 | | |
22 | 26 | | |
| |||
40 | 44 | | |
41 | 45 | | |
42 | 46 | | |
43 | | - | |
| 47 | + | |
| 48 | + | |
| 49 | + | |
| 50 | + | |
| 51 | + | |
| 52 | + | |
| 53 | + | |
44 | 54 | | |
45 | 55 | | |
46 | 56 | | |
| |||
77 | 87 | | |
78 | 88 | | |
79 | 89 | | |
| 90 | + | |
| 91 | + | |
| 92 | + | |
| 93 | + | |
| 94 | + | |
| 95 | + | |
| 96 | + | |
| 97 | + | |
| 98 | + | |
| 99 | + | |
| 100 | + | |
| 101 | + | |
| 102 | + | |
| 103 | + | |
80 | 104 | | |
81 | 105 | | |
| 106 | + | |
| 107 | + | |
| 108 | + | |
| 109 | + | |
| 110 | + | |
| 111 | + | |
| 112 | + | |
| 113 | + | |
| 114 | + | |
| 115 | + | |
| 116 | + | |
| 117 | + | |
| 118 | + | |
| 119 | + | |
| 120 | + | |
| 121 | + | |
| 122 | + | |
| 123 | + | |
| 124 | + | |
| 125 | + | |
| 126 | + | |
| 127 | + | |
| 128 | + | |
| 129 | + | |
| 130 | + | |
| 131 | + | |
| 132 | + | |
| 133 | + | |
| 134 | + | |
| 135 | + | |
| 136 | + | |
| 137 | + | |
82 | 138 | | |
83 | 139 | | |
| 140 | + | |
| 141 | + | |
84 | 142 | | |
85 | 143 | | |
86 | | - | |
| 144 | + | |
87 | 145 | | |
88 | 146 | | |
89 | 147 | | |
90 | | - | |
| 148 | + | |
91 | 149 | | |
92 | | - | |
93 | | - | |
94 | | - | |
95 | | - | |
96 | | - | |
| 150 | + | |
| 151 | + | |
97 | 152 | | |
98 | 153 | | |
99 | 154 | | |
| |||
102 | 157 | | |
103 | 158 | | |
104 | 159 | | |
105 | | - | |
106 | | - | |
| 160 | + | |
| 161 | + | |
| 162 | + | |
| 163 | + | |
| 164 | + | |
| 165 | + | |
| 166 | + | |
| 167 | + | |
| 168 | + | |
| 169 | + | |
| 170 | + | |
| 171 | + | |
| 172 | + | |
| 173 | + | |
| 174 | + | |
| 175 | + | |
| 176 | + | |
| 177 | + | |
| 178 | + | |
| 179 | + | |
| 180 | + | |
| 181 | + | |
| 182 | + | |
| 183 | + | |
| 184 | + | |
| 185 | + | |
| 186 | + | |
| 187 | + | |
| 188 | + | |
| 189 | + | |
| 190 | + | |
| 191 | + | |
| 192 | + | |
| 193 | + | |
| 194 | + | |
| 195 | + | |
| 196 | + | |
| 197 | + | |
| 198 | + | |
| 199 | + | |
| 200 | + | |
| 201 | + | |
107 | 202 | | |
108 | 203 | | |
109 | 204 | | |
110 | | - | |
| 205 | + | |
| 206 | + | |
| 207 | + | |
| 208 | + | |
111 | 209 | | |
112 | | - | |
| 210 | + | |
113 | 211 | | |
114 | 212 | | |
115 | | - | |
116 | | - | |
117 | | - | |
| 213 | + | |
| 214 | + | |
| 215 | + | |
118 | 216 | | |
119 | 217 | | |
120 | | - | |
121 | | - | |
122 | 218 | | |
123 | 219 | | |
124 | 220 | | |
| |||
130 | 226 | | |
131 | 227 | | |
132 | 228 | | |
| 229 | + | |
| 230 | + | |
| 231 | + | |
| 232 | + | |
133 | 233 | | |
134 | 234 | | |
135 | 235 | | |
136 | 236 | | |
137 | | - | |
138 | | - | |
139 | | - | |
140 | | - | |
141 | | - | |
142 | | - | |
| 237 | + | |
| 238 | + | |
| 239 | + | |
| 240 | + | |
143 | 241 | | |
144 | 242 | | |
145 | 243 | | |
| |||
150 | 248 | | |
151 | 249 | | |
152 | 250 | | |
153 | | - | |
154 | | - | |
155 | | - | |
156 | | - | |
157 | | - | |
158 | | - | |
159 | | - | |
160 | | - | |
161 | | - | |
162 | | - | |
163 | | - | |
164 | | - | |
| 251 | + | |
165 | 252 | | |
166 | | - | |
| 253 | + | |
167 | 254 | | |
168 | | - | |
| 255 | + | |
169 | 256 | | |
170 | | - | |
| 257 | + | |
171 | 258 | | |
172 | 259 | | |
173 | 260 | | |
| |||
204 | 291 | | |
205 | 292 | | |
206 | 293 | | |
207 | | - | |
208 | | - | |
209 | | - | |
210 | | - | |
211 | | - | |
212 | | - | |
213 | | - | |
214 | | - | |
215 | | - | |
216 | | - | |
217 | | - | |
218 | | - | |
219 | | - | |
220 | 294 | | |
221 | 295 | | |
222 | 296 | | |
| |||
231 | 305 | | |
232 | 306 | | |
233 | 307 | | |
| 308 | + | |
| 309 | + | |
234 | 310 | | |
235 | 311 | | |
236 | 312 | | |
| |||
256 | 332 | | |
257 | 333 | | |
258 | 334 | | |
| 335 | + | |
| 336 | + | |
| 337 | + | |
| 338 | + | |
| 339 | + | |
| 340 | + | |
| 341 | + | |
| 342 | + | |
| 343 | + | |
| 344 | + | |
| 345 | + | |
| 346 | + | |
| 347 | + | |
| 348 | + | |
| 349 | + | |
| 350 | + | |
| 351 | + | |
| 352 | + | |
| 353 | + | |
| 354 | + | |
| 355 | + | |
| 356 | + | |
| 357 | + | |
| 358 | + | |
| 359 | + | |
| 360 | + | |
| 361 | + | |
| 362 | + | |
| 363 | + | |
| 364 | + | |
| 365 | + | |
| 366 | + | |
| 367 | + | |
| 368 | + | |
| 369 | + | |
| 370 | + | |
259 | 371 | | |
260 | 372 | | |
261 | 373 | | |
262 | 374 | | |
| 375 | + | |
263 | 376 | | |
264 | 377 | | |
265 | | - | |
266 | | - | |
| 378 | + | |
| 379 | + | |
267 | 380 | | |
268 | 381 | | |
269 | 382 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
29 | 29 | | |
30 | 30 | | |
31 | 31 | | |
32 | | - | |
| 32 | + | |
33 | 33 | | |
34 | 34 | | |
35 | 35 | | |
| |||
0 commit comments