@jakkrichm/create-nexus-devflow 2.0.0 → 2.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (394) hide show
  1. package/README.md +96 -50
  2. package/package.json +1 -1
  3. package/template/.agents/skills/20-spec/SKILL.md +136 -136
  4. package/template/.agents/skills/30-plan/SKILL.md +206 -206
  5. package/template/.agents/skills/40-implement/SKILL.md +152 -152
  6. package/template/.agents/skills/50-verify/SKILL.md +174 -174
  7. package/template/.agents/skills/60-report/SKILL.md +168 -168
  8. package/template/.agents/skills/70-release/SKILL.md +141 -141
  9. package/template/.agents/skills/9arm-skills/README.md +51 -51
  10. package/template/.agents/skills/9arm-skills/debug-mantra/SKILL.md +86 -86
  11. package/template/.agents/skills/9arm-skills/management-talk/SKILL.md +79 -79
  12. package/template/.agents/skills/9arm-skills/post-mortem/SKILL.md +71 -71
  13. package/template/.agents/skills/9arm-skills/scrutinize/SKILL.md +72 -72
  14. package/template/.agents/skills/agent/SKILL.md +164 -164
  15. package/template/.agents/skills/api-and-interface-design/SKILL.md +294 -294
  16. package/template/.agents/skills/app-builder/SKILL.md +75 -75
  17. package/template/.agents/skills/app-builder/agent-coordination.md +71 -71
  18. package/template/.agents/skills/app-builder/feature-building.md +53 -53
  19. package/template/.agents/skills/app-builder/project-detection.md +34 -34
  20. package/template/.agents/skills/app-builder/scaffolding.md +118 -118
  21. package/template/.agents/skills/app-builder/tech-stack.md +40 -40
  22. package/template/.agents/skills/app-builder/templates/SKILL.md +39 -39
  23. package/template/.agents/skills/app-builder/templates/astro-static/TEMPLATE.md +76 -76
  24. package/template/.agents/skills/app-builder/templates/chrome-extension/TEMPLATE.md +92 -92
  25. package/template/.agents/skills/app-builder/templates/cli-tool/TEMPLATE.md +88 -88
  26. package/template/.agents/skills/app-builder/templates/electron-desktop/TEMPLATE.md +88 -88
  27. package/template/.agents/skills/app-builder/templates/express-api/TEMPLATE.md +83 -83
  28. package/template/.agents/skills/app-builder/templates/flutter-app/TEMPLATE.md +90 -90
  29. package/template/.agents/skills/app-builder/templates/monorepo-turborepo/TEMPLATE.md +90 -90
  30. package/template/.agents/skills/app-builder/templates/nextjs-fullstack/TEMPLATE.md +122 -122
  31. package/template/.agents/skills/app-builder/templates/nextjs-saas/TEMPLATE.md +122 -122
  32. package/template/.agents/skills/app-builder/templates/nextjs-static/TEMPLATE.md +169 -169
  33. package/template/.agents/skills/app-builder/templates/nuxt-app/TEMPLATE.md +134 -134
  34. package/template/.agents/skills/app-builder/templates/python-fastapi/TEMPLATE.md +83 -83
  35. package/template/.agents/skills/app-builder/templates/react-native-app/TEMPLATE.md +119 -119
  36. package/template/.agents/skills/architecture/SKILL.md +55 -55
  37. package/template/.agents/skills/architecture/context-discovery.md +43 -43
  38. package/template/.agents/skills/architecture/examples.md +94 -94
  39. package/template/.agents/skills/architecture/pattern-selection.md +68 -68
  40. package/template/.agents/skills/architecture/patterns-reference.md +50 -50
  41. package/template/.agents/skills/architecture/trade-off-analysis.md +77 -77
  42. package/template/.agents/skills/bash-linux/SKILL.md +199 -199
  43. package/template/.agents/skills/behavioral-modes/SKILL.md +242 -242
  44. package/template/.agents/skills/brainstorm/SKILL.md +157 -157
  45. package/template/.agents/skills/browser-testing-with-devtools/SKILL.md +302 -302
  46. package/template/.agents/skills/changelog/SKILL.md +108 -108
  47. package/template/.agents/skills/check-for-updates/SKILL.md +116 -116
  48. package/template/.agents/skills/ci-cd-and-automation/SKILL.md +390 -390
  49. package/template/.agents/skills/code-review-and-quality/SKILL.md +392 -392
  50. package/template/.agents/skills/code-simplification/SKILL.md +331 -331
  51. package/template/.agents/skills/commit/SKILL.md +62 -62
  52. package/template/.agents/skills/competitor-analysis/SKILL.md +66 -66
  53. package/template/.agents/skills/context-engineering/SKILL.md +290 -290
  54. package/template/.agents/skills/database-design/SKILL.md +52 -52
  55. package/template/.agents/skills/database-design/database-selection.md +43 -43
  56. package/template/.agents/skills/database-design/indexing.md +39 -39
  57. package/template/.agents/skills/database-design/migrations.md +48 -48
  58. package/template/.agents/skills/database-design/optimization.md +36 -36
  59. package/template/.agents/skills/database-design/orm-selection.md +30 -30
  60. package/template/.agents/skills/database-design/schema-design.md +56 -56
  61. package/template/.agents/skills/database-design/scripts/schema_validator.py +172 -172
  62. package/template/.agents/skills/debug/SKILL.md +116 -116
  63. package/template/.agents/skills/debugging-and-error-recovery/SKILL.md +298 -298
  64. package/template/.agents/skills/deploy/SKILL.md +90 -90
  65. package/template/.agents/skills/deployment-procedures/SKILL.md +241 -241
  66. package/template/.agents/skills/deprecation-and-migration/SKILL.md +206 -206
  67. package/template/.agents/skills/devflow-concept-intake/SKILL.md +150 -150
  68. package/template/.agents/skills/devflow-concept-intake/agents/openai.yaml +4 -4
  69. package/template/.agents/skills/devflow-concept-intake/references/adoption-proposal-template.md +60 -60
  70. package/template/.agents/skills/devflow-concept-intake/references/concept-report-template.md +47 -47
  71. package/template/.agents/skills/devflow-concept-intake/references/upstream-tracking-template.md +51 -51
  72. package/template/.agents/skills/devflow-wiki/SKILL.md +75 -75
  73. package/template/.agents/skills/documentation-and-adrs/SKILL.md +278 -278
  74. package/template/.agents/skills/english-to-thai-translator/SKILL.md +125 -125
  75. package/template/.agents/skills/followup/SKILL.md +78 -78
  76. package/template/.agents/skills/frontend-ui-engineering/SKILL.md +326 -326
  77. package/template/.agents/skills/frontend-ui-engineering/accessibility-checklist.md +159 -159
  78. package/template/.agents/skills/git-workflow-and-versioning/SKILL.md +300 -300
  79. package/template/.agents/skills/goal/SKILL.md +132 -132
  80. package/template/.agents/skills/help/SKILL.md +242 -242
  81. package/template/.agents/skills/human-review-decisions/SKILL.md +74 -74
  82. package/template/.agents/skills/i18n-localization/SKILL.md +154 -154
  83. package/template/.agents/skills/i18n-localization/scripts/i18n_checker.py +241 -241
  84. package/template/.agents/skills/idea-refine/SKILL.md +178 -178
  85. package/template/.agents/skills/idea-refine/examples.md +238 -238
  86. package/template/.agents/skills/idea-refine/frameworks.md +99 -99
  87. package/template/.agents/skills/idea-refine/refinement-criteria.md +113 -113
  88. package/template/.agents/skills/idea-refine/scripts/idea-refine.sh +15 -15
  89. package/template/.agents/skills/incremental-implementation/SKILL.md +248 -248
  90. package/template/.agents/skills/insight/SKILL.md +130 -130
  91. package/template/.agents/skills/insight-capture/SKILL.md +84 -84
  92. package/template/.agents/skills/intelligent-routing/SKILL.md +171 -171
  93. package/template/.agents/skills/issue-triage/SKILL.md +106 -106
  94. package/template/.agents/skills/lint-and-validate/SKILL.md +45 -45
  95. package/template/.agents/skills/lint-and-validate/scripts/lint_runner.py +184 -184
  96. package/template/.agents/skills/lint-and-validate/scripts/type_coverage.py +173 -173
  97. package/template/.agents/skills/mcp-builder/SKILL.md +176 -176
  98. package/template/.agents/skills/md2html/SKILL.md +154 -154
  99. package/template/.agents/skills/md2html/components.md +505 -505
  100. package/template/.agents/skills/md2html/template.html +1152 -1152
  101. package/template/.agents/skills/merge/SKILL.md +75 -75
  102. package/template/.agents/skills/mobile-design/SKILL.md +394 -394
  103. package/template/.agents/skills/mobile-design/decision-trees.md +516 -516
  104. package/template/.agents/skills/mobile-design/mobile-backend.md +491 -491
  105. package/template/.agents/skills/mobile-design/mobile-color-system.md +420 -420
  106. package/template/.agents/skills/mobile-design/mobile-debugging.md +122 -122
  107. package/template/.agents/skills/mobile-design/mobile-design-thinking.md +357 -357
  108. package/template/.agents/skills/mobile-design/mobile-navigation.md +458 -458
  109. package/template/.agents/skills/mobile-design/mobile-performance.md +767 -767
  110. package/template/.agents/skills/mobile-design/mobile-testing.md +356 -356
  111. package/template/.agents/skills/mobile-design/mobile-typography.md +433 -433
  112. package/template/.agents/skills/mobile-design/platform-android.md +666 -666
  113. package/template/.agents/skills/mobile-design/platform-ios.md +561 -561
  114. package/template/.agents/skills/mobile-design/scripts/mobile_audit.py +670 -670
  115. package/template/.agents/skills/mobile-design/touch-psychology.md +537 -537
  116. package/template/.agents/skills/nextjs-react-expert/1-async-eliminating-waterfalls.md +312 -312
  117. package/template/.agents/skills/nextjs-react-expert/2-bundle-bundle-size-optimization.md +240 -240
  118. package/template/.agents/skills/nextjs-react-expert/3-server-server-side-performance.md +490 -490
  119. package/template/.agents/skills/nextjs-react-expert/4-client-client-side-data-fetching.md +264 -264
  120. package/template/.agents/skills/nextjs-react-expert/5-rerender-re-render-optimization.md +581 -581
  121. package/template/.agents/skills/nextjs-react-expert/6-rendering-rendering-performance.md +432 -432
  122. package/template/.agents/skills/nextjs-react-expert/7-js-javascript-performance.md +684 -684
  123. package/template/.agents/skills/nextjs-react-expert/8-advanced-advanced-patterns.md +150 -150
  124. package/template/.agents/skills/nextjs-react-expert/SKILL.md +286 -286
  125. package/template/.agents/skills/nextjs-react-expert/scripts/convert_rules.py +222 -222
  126. package/template/.agents/skills/nextjs-react-expert/scripts/react_performance_checker.py +252 -252
  127. package/template/.agents/skills/nodejs-best-practices/SKILL.md +333 -333
  128. package/template/.agents/skills/obsidian-bases/SKILL.md +506 -506
  129. package/template/.agents/skills/obsidian-bases/references/FUNCTIONS_REFERENCE.md +173 -173
  130. package/template/.agents/skills/obsidian-cli/SKILL.md +115 -115
  131. package/template/.agents/skills/obsidian-clipper-template-creator/SKILL.md +73 -73
  132. package/template/.agents/skills/obsidian-clipper-template-creator/assets/clipping-template.json +51 -51
  133. package/template/.agents/skills/obsidian-clipper-template-creator/assets/recipe-template.json +48 -48
  134. package/template/.agents/skills/obsidian-clipper-template-creator/references/analysis-workflow.md +79 -79
  135. package/template/.agents/skills/obsidian-clipper-template-creator/references/bases-workflow.md +44 -44
  136. package/template/.agents/skills/obsidian-clipper-template-creator/references/filters.md +51 -51
  137. package/template/.agents/skills/obsidian-clipper-template-creator/references/json-schema.md +77 -77
  138. package/template/.agents/skills/obsidian-clipper-template-creator/references/logic.md +67 -67
  139. package/template/.agents/skills/obsidian-clipper-template-creator/references/variables.md +64 -64
  140. package/template/.agents/skills/obsidian-markdown/SKILL.md +205 -205
  141. package/template/.agents/skills/obsidian-markdown/references/CALLOUTS.md +58 -58
  142. package/template/.agents/skills/obsidian-markdown/references/EMBEDS.md +63 -63
  143. package/template/.agents/skills/obsidian-markdown/references/PROPERTIES.md +61 -61
  144. package/template/.agents/skills/package-json-generator/SKILL.md +60 -60
  145. package/template/.agents/skills/package-json-generator/scripts/generate.js +120 -120
  146. package/template/.agents/skills/package-json-generator/scripts/run.sh +19 -19
  147. package/template/.agents/skills/parallel-agents/SKILL.md +144 -144
  148. package/template/.agents/skills/performance-optimization/SKILL.md +299 -299
  149. package/template/.agents/skills/performance-optimization/performance-checklist.md +113 -113
  150. package/template/.agents/skills/planning-and-task-breakdown/SKILL.md +239 -239
  151. package/template/.agents/skills/powershell-windows/SKILL.md +167 -167
  152. package/template/.agents/skills/pr/SKILL.md +92 -92
  153. package/template/.agents/skills/pr-review/SKILL.md +142 -142
  154. package/template/.agents/skills/pr-review-analysis/SKILL.md +89 -89
  155. package/template/.agents/skills/prd/SKILL.md +112 -112
  156. package/template/.agents/skills/preview/SKILL.md +116 -116
  157. package/template/.agents/skills/preview-local-check/SKILL.md +59 -59
  158. package/template/.agents/skills/prompt-addons/SKILL.md +99 -99
  159. package/template/.agents/skills/prp-dev-fastapi/SKILL.md +114 -114
  160. package/template/.agents/skills/prp-dev-multiplatform/SKILL.md +36 -36
  161. package/template/.agents/skills/prp-dev-odoo/SKILL.md +71 -71
  162. package/template/.agents/skills/prp-dev-php/SKILL.md +63 -63
  163. package/template/.agents/skills/prp-sa-ba/SKILL.md +52 -52
  164. package/template/.agents/skills/python-patterns/SKILL.md +441 -441
  165. package/template/.agents/skills/red-team-tactics/SKILL.md +199 -199
  166. package/template/.agents/skills/release-git-operations/SKILL.md +97 -97
  167. package/template/.agents/skills/research/SKILL.md +127 -127
  168. package/template/.agents/skills/review/SKILL.md +55 -55
  169. package/template/.agents/skills/review-followup-routing/SKILL.md +98 -98
  170. package/template/.agents/skills/roadmap-strategy/SKILL.md +97 -97
  171. package/template/.agents/skills/security-and-hardening/SKILL.md +349 -349
  172. package/template/.agents/skills/security-and-hardening/security-checklist.md +134 -134
  173. package/template/.agents/skills/security-review/SKILL.md +164 -164
  174. package/template/.agents/skills/seo-fundamentals/SKILL.md +129 -129
  175. package/template/.agents/skills/seo-fundamentals/scripts/seo_checker.py +219 -219
  176. package/template/.agents/skills/server-management/SKILL.md +161 -161
  177. package/template/.agents/skills/shipping-and-launch/SKILL.md +311 -311
  178. package/template/.agents/skills/silent-failure-audit/SKILL.md +73 -73
  179. package/template/.agents/skills/simplify/SKILL.md +74 -74
  180. package/template/.agents/skills/skill-development/SKILL.md +86 -86
  181. package/template/.agents/skills/spec-driven-development/SKILL.md +207 -207
  182. package/template/.agents/skills/spec-orchestration/SKILL.md +91 -91
  183. package/template/.agents/skills/specialist-agent-routing/SKILL.md +107 -107
  184. package/template/.agents/skills/tailwind-patterns/SKILL.md +269 -269
  185. package/template/.agents/skills/test/SKILL.md +77 -77
  186. package/template/.agents/skills/test-driven-development/SKILL.md +422 -422
  187. package/template/.agents/skills/test-driven-development/testing-patterns.md +236 -236
  188. package/template/.agents/skills/test-execution-and-coverage/SKILL.md +56 -56
  189. package/template/.agents/skills/type-design/SKILL.md +84 -84
  190. package/template/.agents/skills/ui-ux-pro-max/SKILL.md +75 -75
  191. package/template/.agents/skills/using-agent-skills/SKILL.md +171 -171
  192. package/template/.agents/skills/verification-orchestration/SKILL.md +68 -68
  193. package/template/.agents/skills/vulnerability-scanner/SKILL.md +276 -276
  194. package/template/.agents/skills/vulnerability-scanner/checklists.md +121 -121
  195. package/template/.agents/skills/vulnerability-scanner/scripts/security_scan.py +458 -458
  196. package/template/.agents/skills/wiki/SKILL.md +148 -148
  197. package/template/.agents/skills/workflow-documentation-sync/SKILL.md +87 -87
  198. package/template/.claude/skills/20-spec/SKILL.md +136 -136
  199. package/template/.claude/skills/30-plan/SKILL.md +206 -206
  200. package/template/.claude/skills/40-implement/SKILL.md +152 -152
  201. package/template/.claude/skills/50-verify/SKILL.md +174 -174
  202. package/template/.claude/skills/60-report/SKILL.md +168 -168
  203. package/template/.claude/skills/70-release/SKILL.md +141 -141
  204. package/template/.claude/skills/9arm-skills/README.md +51 -51
  205. package/template/.claude/skills/9arm-skills/debug-mantra/SKILL.md +86 -86
  206. package/template/.claude/skills/9arm-skills/management-talk/SKILL.md +79 -79
  207. package/template/.claude/skills/9arm-skills/post-mortem/SKILL.md +71 -71
  208. package/template/.claude/skills/9arm-skills/scrutinize/SKILL.md +72 -72
  209. package/template/.claude/skills/agent/SKILL.md +164 -164
  210. package/template/.claude/skills/api-and-interface-design/SKILL.md +294 -294
  211. package/template/.claude/skills/app-builder/SKILL.md +75 -75
  212. package/template/.claude/skills/app-builder/agent-coordination.md +71 -71
  213. package/template/.claude/skills/app-builder/feature-building.md +53 -53
  214. package/template/.claude/skills/app-builder/project-detection.md +34 -34
  215. package/template/.claude/skills/app-builder/scaffolding.md +118 -118
  216. package/template/.claude/skills/app-builder/tech-stack.md +40 -40
  217. package/template/.claude/skills/app-builder/templates/SKILL.md +39 -39
  218. package/template/.claude/skills/app-builder/templates/astro-static/TEMPLATE.md +76 -76
  219. package/template/.claude/skills/app-builder/templates/chrome-extension/TEMPLATE.md +92 -92
  220. package/template/.claude/skills/app-builder/templates/cli-tool/TEMPLATE.md +88 -88
  221. package/template/.claude/skills/app-builder/templates/electron-desktop/TEMPLATE.md +88 -88
  222. package/template/.claude/skills/app-builder/templates/express-api/TEMPLATE.md +83 -83
  223. package/template/.claude/skills/app-builder/templates/flutter-app/TEMPLATE.md +90 -90
  224. package/template/.claude/skills/app-builder/templates/monorepo-turborepo/TEMPLATE.md +90 -90
  225. package/template/.claude/skills/app-builder/templates/nextjs-fullstack/TEMPLATE.md +122 -122
  226. package/template/.claude/skills/app-builder/templates/nextjs-saas/TEMPLATE.md +122 -122
  227. package/template/.claude/skills/app-builder/templates/nextjs-static/TEMPLATE.md +169 -169
  228. package/template/.claude/skills/app-builder/templates/nuxt-app/TEMPLATE.md +134 -134
  229. package/template/.claude/skills/app-builder/templates/python-fastapi/TEMPLATE.md +83 -83
  230. package/template/.claude/skills/app-builder/templates/react-native-app/TEMPLATE.md +119 -119
  231. package/template/.claude/skills/architecture/SKILL.md +55 -55
  232. package/template/.claude/skills/architecture/context-discovery.md +43 -43
  233. package/template/.claude/skills/architecture/examples.md +94 -94
  234. package/template/.claude/skills/architecture/pattern-selection.md +68 -68
  235. package/template/.claude/skills/architecture/patterns-reference.md +50 -50
  236. package/template/.claude/skills/architecture/trade-off-analysis.md +77 -77
  237. package/template/.claude/skills/bash-linux/SKILL.md +199 -199
  238. package/template/.claude/skills/behavioral-modes/SKILL.md +242 -242
  239. package/template/.claude/skills/brainstorm/SKILL.md +157 -157
  240. package/template/.claude/skills/browser-testing-with-devtools/SKILL.md +302 -302
  241. package/template/.claude/skills/changelog/SKILL.md +108 -108
  242. package/template/.claude/skills/check-for-updates/SKILL.md +116 -116
  243. package/template/.claude/skills/ci-cd-and-automation/SKILL.md +390 -390
  244. package/template/.claude/skills/code-review-and-quality/SKILL.md +392 -392
  245. package/template/.claude/skills/code-simplification/SKILL.md +331 -331
  246. package/template/.claude/skills/commit/SKILL.md +62 -62
  247. package/template/.claude/skills/competitor-analysis/SKILL.md +66 -66
  248. package/template/.claude/skills/context-engineering/SKILL.md +290 -290
  249. package/template/.claude/skills/database-design/SKILL.md +52 -52
  250. package/template/.claude/skills/database-design/database-selection.md +43 -43
  251. package/template/.claude/skills/database-design/indexing.md +39 -39
  252. package/template/.claude/skills/database-design/migrations.md +48 -48
  253. package/template/.claude/skills/database-design/optimization.md +36 -36
  254. package/template/.claude/skills/database-design/orm-selection.md +30 -30
  255. package/template/.claude/skills/database-design/schema-design.md +56 -56
  256. package/template/.claude/skills/database-design/scripts/schema_validator.py +172 -172
  257. package/template/.claude/skills/debug/SKILL.md +116 -116
  258. package/template/.claude/skills/debugging-and-error-recovery/SKILL.md +298 -298
  259. package/template/.claude/skills/deploy/SKILL.md +90 -90
  260. package/template/.claude/skills/deployment-procedures/SKILL.md +241 -241
  261. package/template/.claude/skills/deprecation-and-migration/SKILL.md +206 -206
  262. package/template/.claude/skills/devflow-concept-intake/SKILL.md +150 -150
  263. package/template/.claude/skills/devflow-concept-intake/agents/openai.yaml +4 -4
  264. package/template/.claude/skills/devflow-concept-intake/references/adoption-proposal-template.md +60 -60
  265. package/template/.claude/skills/devflow-concept-intake/references/concept-report-template.md +47 -47
  266. package/template/.claude/skills/devflow-concept-intake/references/upstream-tracking-template.md +51 -51
  267. package/template/.claude/skills/devflow-wiki/SKILL.md +75 -75
  268. package/template/.claude/skills/documentation-and-adrs/SKILL.md +278 -278
  269. package/template/.claude/skills/english-to-thai-translator/SKILL.md +125 -125
  270. package/template/.claude/skills/followup/SKILL.md +78 -78
  271. package/template/.claude/skills/frontend-ui-engineering/SKILL.md +326 -326
  272. package/template/.claude/skills/frontend-ui-engineering/accessibility-checklist.md +159 -159
  273. package/template/.claude/skills/git-workflow-and-versioning/SKILL.md +300 -300
  274. package/template/.claude/skills/goal/SKILL.md +132 -132
  275. package/template/.claude/skills/help/SKILL.md +242 -242
  276. package/template/.claude/skills/human-review-decisions/SKILL.md +74 -74
  277. package/template/.claude/skills/i18n-localization/SKILL.md +154 -154
  278. package/template/.claude/skills/i18n-localization/scripts/i18n_checker.py +241 -241
  279. package/template/.claude/skills/idea-refine/SKILL.md +178 -178
  280. package/template/.claude/skills/idea-refine/examples.md +238 -238
  281. package/template/.claude/skills/idea-refine/frameworks.md +99 -99
  282. package/template/.claude/skills/idea-refine/refinement-criteria.md +113 -113
  283. package/template/.claude/skills/idea-refine/scripts/idea-refine.sh +15 -15
  284. package/template/.claude/skills/incremental-implementation/SKILL.md +248 -248
  285. package/template/.claude/skills/insight/SKILL.md +130 -130
  286. package/template/.claude/skills/insight-capture/SKILL.md +84 -84
  287. package/template/.claude/skills/intelligent-routing/SKILL.md +171 -171
  288. package/template/.claude/skills/issue-triage/SKILL.md +106 -106
  289. package/template/.claude/skills/lint-and-validate/SKILL.md +45 -45
  290. package/template/.claude/skills/lint-and-validate/scripts/lint_runner.py +184 -184
  291. package/template/.claude/skills/lint-and-validate/scripts/type_coverage.py +173 -173
  292. package/template/.claude/skills/mcp-builder/SKILL.md +176 -176
  293. package/template/.claude/skills/md2html/SKILL.md +154 -154
  294. package/template/.claude/skills/md2html/components.md +505 -505
  295. package/template/.claude/skills/md2html/template.html +1152 -1152
  296. package/template/.claude/skills/merge/SKILL.md +75 -75
  297. package/template/.claude/skills/mobile-design/SKILL.md +394 -394
  298. package/template/.claude/skills/mobile-design/decision-trees.md +516 -516
  299. package/template/.claude/skills/mobile-design/mobile-backend.md +491 -491
  300. package/template/.claude/skills/mobile-design/mobile-color-system.md +420 -420
  301. package/template/.claude/skills/mobile-design/mobile-debugging.md +122 -122
  302. package/template/.claude/skills/mobile-design/mobile-design-thinking.md +357 -357
  303. package/template/.claude/skills/mobile-design/mobile-navigation.md +458 -458
  304. package/template/.claude/skills/mobile-design/mobile-performance.md +767 -767
  305. package/template/.claude/skills/mobile-design/mobile-testing.md +356 -356
  306. package/template/.claude/skills/mobile-design/mobile-typography.md +433 -433
  307. package/template/.claude/skills/mobile-design/platform-android.md +666 -666
  308. package/template/.claude/skills/mobile-design/platform-ios.md +561 -561
  309. package/template/.claude/skills/mobile-design/scripts/mobile_audit.py +670 -670
  310. package/template/.claude/skills/mobile-design/touch-psychology.md +537 -537
  311. package/template/.claude/skills/nextjs-react-expert/1-async-eliminating-waterfalls.md +312 -312
  312. package/template/.claude/skills/nextjs-react-expert/2-bundle-bundle-size-optimization.md +240 -240
  313. package/template/.claude/skills/nextjs-react-expert/3-server-server-side-performance.md +490 -490
  314. package/template/.claude/skills/nextjs-react-expert/4-client-client-side-data-fetching.md +264 -264
  315. package/template/.claude/skills/nextjs-react-expert/5-rerender-re-render-optimization.md +581 -581
  316. package/template/.claude/skills/nextjs-react-expert/6-rendering-rendering-performance.md +432 -432
  317. package/template/.claude/skills/nextjs-react-expert/7-js-javascript-performance.md +684 -684
  318. package/template/.claude/skills/nextjs-react-expert/8-advanced-advanced-patterns.md +150 -150
  319. package/template/.claude/skills/nextjs-react-expert/SKILL.md +286 -286
  320. package/template/.claude/skills/nextjs-react-expert/scripts/convert_rules.py +222 -222
  321. package/template/.claude/skills/nextjs-react-expert/scripts/react_performance_checker.py +252 -252
  322. package/template/.claude/skills/nodejs-best-practices/SKILL.md +333 -333
  323. package/template/.claude/skills/obsidian-bases/SKILL.md +506 -506
  324. package/template/.claude/skills/obsidian-bases/references/FUNCTIONS_REFERENCE.md +173 -173
  325. package/template/.claude/skills/obsidian-cli/SKILL.md +115 -115
  326. package/template/.claude/skills/obsidian-clipper-template-creator/SKILL.md +73 -73
  327. package/template/.claude/skills/obsidian-clipper-template-creator/assets/clipping-template.json +51 -51
  328. package/template/.claude/skills/obsidian-clipper-template-creator/assets/recipe-template.json +48 -48
  329. package/template/.claude/skills/obsidian-clipper-template-creator/references/analysis-workflow.md +79 -79
  330. package/template/.claude/skills/obsidian-clipper-template-creator/references/bases-workflow.md +44 -44
  331. package/template/.claude/skills/obsidian-clipper-template-creator/references/filters.md +51 -51
  332. package/template/.claude/skills/obsidian-clipper-template-creator/references/json-schema.md +77 -77
  333. package/template/.claude/skills/obsidian-clipper-template-creator/references/logic.md +67 -67
  334. package/template/.claude/skills/obsidian-clipper-template-creator/references/variables.md +64 -64
  335. package/template/.claude/skills/obsidian-markdown/SKILL.md +205 -205
  336. package/template/.claude/skills/obsidian-markdown/references/CALLOUTS.md +58 -58
  337. package/template/.claude/skills/obsidian-markdown/references/EMBEDS.md +63 -63
  338. package/template/.claude/skills/obsidian-markdown/references/PROPERTIES.md +61 -61
  339. package/template/.claude/skills/package-json-generator/SKILL.md +60 -60
  340. package/template/.claude/skills/package-json-generator/scripts/generate.js +120 -120
  341. package/template/.claude/skills/package-json-generator/scripts/run.sh +19 -19
  342. package/template/.claude/skills/parallel-agents/SKILL.md +144 -144
  343. package/template/.claude/skills/performance-optimization/SKILL.md +299 -299
  344. package/template/.claude/skills/performance-optimization/performance-checklist.md +113 -113
  345. package/template/.claude/skills/planning-and-task-breakdown/SKILL.md +239 -239
  346. package/template/.claude/skills/powershell-windows/SKILL.md +167 -167
  347. package/template/.claude/skills/pr/SKILL.md +92 -92
  348. package/template/.claude/skills/pr-review/SKILL.md +142 -142
  349. package/template/.claude/skills/pr-review-analysis/SKILL.md +89 -89
  350. package/template/.claude/skills/prd/SKILL.md +112 -112
  351. package/template/.claude/skills/preview/SKILL.md +116 -116
  352. package/template/.claude/skills/preview-local-check/SKILL.md +59 -59
  353. package/template/.claude/skills/prompt-addons/SKILL.md +99 -99
  354. package/template/.claude/skills/prp-dev-fastapi/SKILL.md +114 -114
  355. package/template/.claude/skills/prp-dev-multiplatform/SKILL.md +36 -36
  356. package/template/.claude/skills/prp-dev-odoo/SKILL.md +71 -71
  357. package/template/.claude/skills/prp-dev-php/SKILL.md +63 -63
  358. package/template/.claude/skills/prp-sa-ba/SKILL.md +52 -52
  359. package/template/.claude/skills/python-patterns/SKILL.md +441 -441
  360. package/template/.claude/skills/red-team-tactics/SKILL.md +199 -199
  361. package/template/.claude/skills/release-git-operations/SKILL.md +97 -97
  362. package/template/.claude/skills/research/SKILL.md +127 -127
  363. package/template/.claude/skills/review/SKILL.md +55 -55
  364. package/template/.claude/skills/review-followup-routing/SKILL.md +98 -98
  365. package/template/.claude/skills/roadmap-strategy/SKILL.md +97 -97
  366. package/template/.claude/skills/security-and-hardening/SKILL.md +349 -349
  367. package/template/.claude/skills/security-and-hardening/security-checklist.md +134 -134
  368. package/template/.claude/skills/security-review/SKILL.md +164 -164
  369. package/template/.claude/skills/seo-fundamentals/SKILL.md +129 -129
  370. package/template/.claude/skills/seo-fundamentals/scripts/seo_checker.py +219 -219
  371. package/template/.claude/skills/server-management/SKILL.md +161 -161
  372. package/template/.claude/skills/shipping-and-launch/SKILL.md +311 -311
  373. package/template/.claude/skills/silent-failure-audit/SKILL.md +73 -73
  374. package/template/.claude/skills/simplify/SKILL.md +74 -74
  375. package/template/.claude/skills/skill-development/SKILL.md +86 -86
  376. package/template/.claude/skills/spec-driven-development/SKILL.md +207 -207
  377. package/template/.claude/skills/spec-orchestration/SKILL.md +91 -91
  378. package/template/.claude/skills/specialist-agent-routing/SKILL.md +107 -107
  379. package/template/.claude/skills/tailwind-patterns/SKILL.md +269 -269
  380. package/template/.claude/skills/test/SKILL.md +77 -77
  381. package/template/.claude/skills/test-driven-development/SKILL.md +422 -422
  382. package/template/.claude/skills/test-driven-development/testing-patterns.md +236 -236
  383. package/template/.claude/skills/test-execution-and-coverage/SKILL.md +56 -56
  384. package/template/.claude/skills/type-design/SKILL.md +84 -84
  385. package/template/.claude/skills/ui-ux-pro-max/SKILL.md +75 -75
  386. package/template/.claude/skills/using-agent-skills/SKILL.md +171 -171
  387. package/template/.claude/skills/verification-orchestration/SKILL.md +68 -68
  388. package/template/.claude/skills/vulnerability-scanner/SKILL.md +276 -276
  389. package/template/.claude/skills/vulnerability-scanner/checklists.md +121 -121
  390. package/template/.claude/skills/vulnerability-scanner/scripts/security_scan.py +458 -458
  391. package/template/.claude/skills/wiki/SKILL.md +148 -148
  392. package/template/.claude/skills/workflow-documentation-sync/SKILL.md +87 -87
  393. package/template/.nexus/nexus-devflow.json +1 -1
  394. package/template/LICENSE +21 -21
@@ -1,505 +1,505 @@
1
- # md2html — Component Catalog
2
-
3
- This file is the **single source of truth** for the HTML snippets you (the AI) must use when filling `template.html`.
4
-
5
- **Rules:**
6
- - Copy snippets verbatim, only replace the bracketed `{{...}}` placeholders.
7
- - Never invent new CSS classes — every visual element MUST be one of these components or vanilla markdown HTML (`<h2>`, `<p>`, `<ul>`, etc.).
8
- - All sample text in this catalog is illustrative — replace with real content from the source `.md`.
9
- - **Language follows the source**: if source `.md` is English, output English UI labels; if Vietnamese, output Vietnamese. See the label table below. For other languages, use the equivalent translations.
10
- - **Use SVG icons via the sprite, never emojis.** All icons reference IDs defined in `template.html`'s `<svg class="icon-sprite">`. Form: `<svg class="icon" viewBox="0 0 24 24" aria-hidden="true"><use href="#i-NAME"/></svg>`. See §13 for the full catalog of available icon IDs.
11
-
12
- ## Language label table
13
-
14
- The HTML's `<html lang="...">` attribute MUST be set to match the source language (ISO 639-1: `en`, `vi`, `zh`, `ja`, `ko`, `es`, `fr`, `de`, `ru`, `ar`, `th`, …). The "Recommended" badge label is set via the `--rec-label` CSS variable on `<html>` — any language works without CSS edits.
15
-
16
- ```html
17
- <!-- example: Chinese source -->
18
- <html lang="zh" data-theme="light" style="--rec-label: '★ 推荐'">
19
-
20
- <!-- example: Japanese source -->
21
- <html lang="ja" data-theme="light" style="--rec-label: '★ 推奨'">
22
- ```
23
-
24
- ### Common UI labels by language
25
-
26
- | Key | EN | VI | ZH (中文) | JA (日本語) | KO (한국어) | ES | FR | DE |
27
- |--- |--- |--- |--- |--- |--- |--- |--- |--- |
28
- | `{{TOC_TITLE}}` | Contents | Mục lục | 目录 | 目次 | 목차 | Contenido | Sommaire | Inhalt |
29
- | `{{REC_LABEL}}` | ★ Recommended | ★ Đề xuất | ★ 推荐 | ★ 推奨 | ★ 추천 | ★ Recomendado | ★ Recommandé | ★ Empfohlen |
30
- | `{{PRINT_TOOLTIP}}`| Print / Save PDF | In / Lưu PDF | 打印 / 保存 PDF | 印刷 / PDF 保存 | 인쇄 / PDF 저장 | Imprimir / Guardar | Imprimer / PDF | Drucken / PDF |
31
- | `{{THEME_TOOLTIP}}`| Toggle theme | Đổi theme | 切换主题 | テーマ切替 | 테마 전환 | Cambiar tema | Changer thème | Theme wechseln |
32
- | Read-time suffix | ~N min read | ~N phút đọc | ~N 分钟阅读 | ~N 分で読了 | ~N분 소요 | ~N min de lectura | ~N min de lecture | ~N Min. Lesezeit |
33
- | Highlight label | Key point | Ý chính | 要点 | 要点 | 핵심 | Idea clave | Point clé | Kernpunkt |
34
- | Pros heading | ✓ Pros | ✓ Ưu điểm | ✓ 优点 | ✓ 長所 | ✓ 장점 | ✓ Ventajas | ✓ Avantages | ✓ Vorteile |
35
- | Cons heading | ✕ Cons | ✕ Nhược điểm | ✕ 缺点 | ✕ 短所 | ✕ 단점 | ✕ Desventajas | ✕ Inconvénients | ✕ Nachteile |
36
- | Source: prefix | Source: | Nguồn: | 来源: | ソース: | 소스: | Fuente: | Source : | Quelle: |
37
- | Brand — PLAN | Plan | Kế hoạch | 计划 | 計画 | 계획 | Plan | Plan | Plan |
38
- | Brand — SPEC | Spec | Đặc tả | 规格 | 仕様 | 사양 | Especificación | Spécification | Spezifikation |
39
- | Brand — SYSTEM DESIGN | System Design | Thiết kế hệ thống | 系统设计 | システム設計 | 시스템 설계 | Diseño de sistema | Conception système | Systemdesign |
40
- | Brand — RFC / RUNBOOK / POSTMORTEM | (keep) | (keep) | (keep) | (keep) | (keep) | (keep) | (keep) | (keep) |
41
- | Brand — BRAINSTORM | Brainstorm | Ý tưởng | 头脑风暴 | ブレスト | 브레인스토밍 | Lluvia de ideas | Brainstorming | Brainstorming |
42
- | Brand — NOTES | Notes | Ghi chú | 笔记 | メモ | 메모 | Notas | Notes | Notizen |
43
-
44
- ### Default callout titles (override with source-specific phrases when possible)
45
-
46
- | Variant | EN | VI | ZH | JA | KO | ES |
47
- |--- |--- |--- |--- |--- |--- |--- |
48
- | info | Context | Bối cảnh | 背景 | 背景 | 배경 | Contexto |
49
- | warn | Heads up | Cảnh báo | 注意 | 注意 | 주의 | Atención |
50
- | danger | Do not do this | Không được làm | 禁止操作 | 禁止 | 금지 | No hacer |
51
- | success | Done | Đã hoàn thành | 已完成 | 完了 | 완료 | Hecho |
52
- | decision | Decision | Quyết định | 决定 | 決定 | 결정 | Decisión |
53
- | tip | Tip | Gợi ý | 提示 | ヒント | 팁 | Consejo |
54
-
55
- **Notes:**
56
- - For a language not listed, translate using the same conventions — every label has a natural equivalent.
57
- - The "Doc-type eyebrow" (`PLAN`, `SPEC`, `RFC`, `RUNBOOK`, `POSTMORTEM`, `NOTES`) stays as the uppercase English code in **all languages** — it's a universal tag, not a translatable label.
58
- - Body content (paragraphs, step descriptions, callout bodies, headings H2/H3) is always in the source language — paraphrased but never translated to another language.
59
- - CJK languages (zh/ja/ko) inherit `font-family: var(--font-sans)` which falls back to system fonts that include CJK glyphs (PingFang on macOS, Microsoft YaHei on Windows, Noto Sans CJK on Linux). No font change needed for correct rendering.
60
-
61
- ---
62
-
63
- ## 1. Title block (in `<header class="doc-header">`)
64
-
65
- Replace `{{TITLE}}`, `{{SUBTITLE}}`, `{{DOC_TYPE}}`, `{{SOURCE_FILE}}`, `{{DATE}}`, `{{READ_TIME}}` in `template.html`.
66
-
67
- - `{{DOC_TYPE}}` examples: `PLAN`, `SPEC`, `SYSTEM DESIGN`, `RFC`, `NOTES`, `RUNBOOK`, `POSTMORTEM`.
68
- - `{{READ_TIME}}` format: `~5 phút đọc` (estimate ~250 words/minute).
69
-
70
- ---
71
-
72
- ## 2. TOC entry — goes inside `<nav class="toc-nav">`
73
-
74
- ```html
75
- <a href="#section-id" class="lvl-2">Tên section</a>
76
- <a href="#subsection-id" class="lvl-3">Tên sub-section</a>
77
- ```
78
-
79
- - One `<a>` per H2/H3 in the document.
80
- - The `href` must match an `id="..."` on the target heading: `<h2 id="section-id">...</h2>`.
81
- - Use `class="lvl-2"` for top-level (H2), `class="lvl-3"` for nested (H3). Skip H4 to avoid clutter.
82
-
83
- ---
84
-
85
- ## 3. Step card / Timeline
86
-
87
- For numbered sequences (action items, plan steps, migration steps, workflow). Wrap multiple `.step` in a `.timeline`.
88
-
89
- ```html
90
- <div class="timeline">
91
- <article class="step">
92
- <div class="step-num">1</div>
93
- <div class="step-body">
94
- <h3>Tiêu đề bước</h3>
95
- <p>Mô tả ngắn gọn 1-2 câu về việc cần làm và lý do.</p>
96
- <div class="step-tags">
97
- <span class="tag">backend</span>
98
- <span class="tag">~2 ngày</span>
99
- </div>
100
- </div>
101
- </article>
102
- <article class="step">
103
- <div class="step-num">2</div>
104
- <div class="step-body">
105
- <h3>Bước tiếp theo</h3>
106
- <p>...</p>
107
- </div>
108
- </article>
109
- </div>
110
- ```
111
-
112
- - Add `class="step done"` to mark a completed step (circle filled).
113
- - Tags are optional — use for owner, ETA, area, dependencies.
114
- - Keep `<h3>` short (≤ 60 chars); detail goes in `<p>`.
115
-
116
- ---
117
-
118
- ## 4. Callouts
119
-
120
- Use for important asides. Pick the variant that matches semantic meaning.
121
-
122
- ### 4a. Info — context, background, FYI
123
- ```html
124
- <aside class="callout callout-info">
125
- <svg class="callout-icon" viewBox="0 0 24 24" aria-hidden="true"><use href="#i-info"/></svg>
126
- <div class="callout-body">
127
- <p class="callout-title">Bối cảnh</p>
128
- <p>Hệ thống hiện tại dùng cron 5 phút, gây trễ end-to-end ~3 phút.</p>
129
- </div>
130
- </aside>
131
- ```
132
-
133
- ### 4b. Warning — gotcha, edge case, risk
134
- ```html
135
- <aside class="callout callout-warn">
136
- <svg class="callout-icon" viewBox="0 0 24 24" aria-hidden="true"><use href="#i-warn"/></svg>
137
- <div class="callout-body">
138
- <p class="callout-title">Cảnh báo</p>
139
- <p>Migration này khoá bảng <code>orders</code> ~30s khi chạy production.</p>
140
- </div>
141
- </aside>
142
- ```
143
-
144
- ### 4c. Danger — blocker, breaking change, must-not-do
145
- ```html
146
- <aside class="callout callout-danger">
147
- <svg class="callout-icon" viewBox="0 0 24 24" aria-hidden="true"><use href="#i-danger"/></svg>
148
- <div class="callout-body">
149
- <p class="callout-title">Không được làm</p>
150
- <p>Tuyệt đối không drop column trước khi rollout deploy cũ.</p>
151
- </div>
152
- </aside>
153
- ```
154
-
155
- ### 4d. Success — confirmation, what's already done
156
- ```html
157
- <aside class="callout callout-success">
158
- <svg class="callout-icon" viewBox="0 0 24 24" aria-hidden="true"><use href="#i-success"/></svg>
159
- <div class="callout-body">
160
- <p class="callout-title">Đã hoàn thành</p>
161
- <p>API mới đã được test load 10k RPS, p99 = 80ms.</p>
162
- </div>
163
- </aside>
164
- ```
165
-
166
- ### 4e. Decision — recorded decision / ADR
167
- ```html
168
- <aside class="callout callout-decision">
169
- <svg class="callout-icon" viewBox="0 0 24 24" aria-hidden="true"><use href="#i-decision"/></svg>
170
- <div class="callout-body">
171
- <p class="callout-title">Quyết định</p>
172
- <p>Chọn Postgres thay vì MongoDB vì cần transaction ACID cho luồng thanh toán.</p>
173
- </div>
174
- </aside>
175
- ```
176
-
177
- ### 4f. Tip — recommendation, best practice
178
- ```html
179
- <aside class="callout callout-tip">
180
- <svg class="callout-icon" viewBox="0 0 24 24" aria-hidden="true"><use href="#i-tip"/></svg>
181
- <div class="callout-body">
182
- <p class="callout-title">Gợi ý</p>
183
- <p>Cache kết quả truy vấn này 5 phút để giảm 80% tải DB.</p>
184
- </div>
185
- </aside>
186
- ```
187
-
188
- ### 4g. Security — using lock icon for auth/security notes
189
- ```html
190
- <aside class="callout callout-info">
191
- <svg class="callout-icon" viewBox="0 0 24 24" aria-hidden="true"><use href="#i-lock"/></svg>
192
- <div class="callout-body">
193
- <p class="callout-title">Bảo mật</p>
194
- <p>Webhook chạy nội bộ trong VPC, không qua public internet.</p>
195
- </div>
196
- </aside>
197
- ```
198
-
199
- ---
200
-
201
- ## 5. Key-point highlight
202
-
203
- For the single most important insight/conclusion of a section.
204
-
205
- ```html
206
- <!-- VI -->
207
- <div class="highlight">
208
- <span class="highlight-label">Ý chính</span>
209
- <p>Tóm lại: chuyển từ polling sang webhook giảm độ trễ từ 3 phút xuống &lt;5s và tiết kiệm 60% lượng API call.</p>
210
- </div>
211
-
212
- <!-- EN -->
213
- <div class="highlight">
214
- <span class="highlight-label">Key point</span>
215
- <p>Bottom line: moving from polling to webhooks cuts latency from 3 minutes to &lt;5s and saves 60% of API calls.</p>
216
- </div>
217
- ```
218
-
219
- - Use sparingly (≤ 1 per major section). If everything is highlighted, nothing is.
220
- - The `highlight-label` text comes from the language label table above.
221
-
222
- ---
223
-
224
- ## 6. Mermaid diagram
225
-
226
- Detect these patterns in source `.md` and convert them:
227
- - "flow / luồng / step A → step B → step C" → `graph LR` or `flowchart TD`
228
- - "client gọi server, server gọi DB" → `sequenceDiagram`
229
- - "table A có FK đến table B" → `erDiagram`
230
- - "state machine / trạng thái" → `stateDiagram-v2`
231
- - "phases / roadmap / timeline" → `gantt`
232
-
233
- ```html
234
- <figure class="diagram">
235
- <pre class="mermaid">
236
- flowchart LR
237
- A[User] -->|POST /order| B(API Gateway)
238
- B --> C{Auth?}
239
- C -->|yes| D[Order Service]
240
- C -->|no| E[401]
241
- D --> F[(Postgres)]
242
- D --> G[/Event bus/]
243
- </pre>
244
- <figcaption class="diagram-caption">Luồng tạo đơn hàng từ user đến event bus.</figcaption>
245
- </figure>
246
- ```
247
-
248
- **Mermaid tips for readable output:**
249
- - Prefer `LR` (left-right) for flows with ≤ 6 nodes, `TD` for vertical hierarchies.
250
- - Keep node labels short (≤ 3 words). Detail goes in caption.
251
- - Use `(...)` for service/process, `[...]` for box, `[(...)]` for database, `((...)) ` for circle, `{...}` for decision, `/.../` for queue/event.
252
- - Always add a `<figcaption>` explaining what the diagram shows.
253
-
254
- **Convert architecture description to mermaid:**
255
- > "Client gọi API Gateway. Gateway xác thực JWT, rồi route đến Order Service. Order Service ghi vào Postgres và publish event qua Kafka."
256
-
257
- Becomes:
258
- ```
259
- flowchart LR
260
- Client --> Gateway
261
- Gateway -->|verify JWT| Order[Order Service]
262
- Order --> DB[(Postgres)]
263
- Order --> Kafka[/Kafka/]
264
- ```
265
-
266
- ---
267
-
268
- ## 7. Pros / Cons table
269
-
270
- For trade-off discussions ("Option X có ưu/nhược điểm…" / "Trade-offs of X…").
271
-
272
- ```html
273
- <!-- VI -->
274
- <div class="proscons">
275
- <div class="proscons-col pros">
276
- <h4>✓ Ưu điểm</h4>
277
- <ul>
278
- <li>Triển khai nhanh, không cần thay schema.</li>
279
- <li>Backward compatible với client cũ.</li>
280
- </ul>
281
- </div>
282
- <div class="proscons-col cons">
283
- <h4>✕ Nhược điểm</h4>
284
- <ul>
285
- <li>Tăng độ phức tạp ở tầng routing.</li>
286
- <li>Phải maintain 2 đường code trong 1 quý.</li>
287
- </ul>
288
- </div>
289
- </div>
290
-
291
- <!-- EN -->
292
- <div class="proscons">
293
- <div class="proscons-col pros">
294
- <h4>✓ Pros</h4>
295
- <ul>
296
- <li>Fast to ship, no schema change required.</li>
297
- <li>Backward compatible with existing clients.</li>
298
- </ul>
299
- </div>
300
- <div class="proscons-col cons">
301
- <h4>✕ Cons</h4>
302
- <ul>
303
- <li>Adds complexity to the routing layer.</li>
304
- <li>Two code paths to maintain for one quarter.</li>
305
- </ul>
306
- </div>
307
- </div>
308
- ```
309
-
310
- - The `<h4>` text follows the language label table.
311
-
312
- ---
313
-
314
- ## 8. Comparison cards
315
-
316
- For "Option A vs B vs C" — when there are ≥ 2 alternatives to compare.
317
-
318
- ```html
319
- <div class="compare">
320
- <div class="compare-card recommended">
321
- <h4>Option B — Hybrid cache</h4>
322
- <p>Redis L1 + DB fallback. Balances latency and complexity.</p>
323
- </div>
324
- <div class="compare-card">
325
- <h4>Option A — DB only</h4>
326
- <p>Simplest but p99 latency hits 800ms at peak.</p>
327
- </div>
328
- <div class="compare-card">
329
- <h4>Option C — In-memory map</h4>
330
- <p>Fastest but loses state on restart, no horizontal scaling.</p>
331
- </div>
332
- </div>
333
- ```
334
-
335
- - Add `class="recommended"` to the preferred option → ★ badge appears automatically. The badge text comes from `--rec-label` set on `<html style="...">` (see the language table above). Falls back to `★ Recommended` if not set.
336
- - Put the recommended option **first** so the reader sees it immediately.
337
- - All body text follows source language — sample above is English; for a Vietnamese / Chinese / Japanese / … source, write descriptions in that language.
338
-
339
- ---
340
-
341
- ## 9. Collapsible section
342
-
343
- For optional / deep-dive content the reader can skip.
344
-
345
- ```html
346
- <details class="collapsible">
347
- <summary>Chi tiết kỹ thuật về sharding strategy</summary>
348
- <div class="collapsible-body">
349
- <p>Dùng consistent hashing với 256 virtual nodes per physical shard...</p>
350
- <pre><code>const shard = hash(userId) % SHARDS;</code></pre>
351
- </div>
352
- </details>
353
- ```
354
-
355
- **When to collapse:**
356
- - Long code blocks (> 30 dòng)
357
- - Background context không phải reader nào cũng cần
358
- - Alternative approaches đã bị reject
359
- - Detailed FAQ
360
-
361
- ---
362
-
363
- ## 10. Plain Markdown elements
364
-
365
- These render correctly out-of-the-box with the CSS in `template.html` — just use HTML equivalents:
366
-
367
- | Markdown | HTML to write |
368
- |---|---|
369
- | `## Heading` | `<h2 id="kebab-case-id">Heading</h2>` |
370
- | `### Sub` | `<h3 id="kebab-case-id">Sub</h3>` |
371
- | `**bold**` | `<strong>bold</strong>` |
372
- | `inline code` | `<code>inline code</code>` |
373
- | ```` ```js code``` ```` | `<pre><code>js code</code></pre>` |
374
- | `- item` | `<ul><li>item</li></ul>` |
375
- | `1. item` | `<ol><li>item</li></ol>` (chỉ dùng khi KHÔNG phải timeline) |
376
- | `> quote` | `<blockquote>quote</blockquote>` |
377
- | `--- table ---` | `<table>...</table>` |
378
- | `[text](url)` | `<a href="url">text</a>` |
379
-
380
- ---
381
-
382
- ## 11. Component selection cheatsheet
383
-
384
- Áp dụng heuristics này khi đọc source `.md`:
385
-
386
- | Pattern trong source | Component nên dùng |
387
- |---|---|
388
- | Numbered list of action items (`1. làm X`, `2. làm Y`) | Step / Timeline (§3) |
389
- | Architecture description với A gọi B gọi C | Mermaid flowchart (§6) |
390
- | "Client → Server → DB" trong text | Mermaid sequence/flow (§6) |
391
- | Schema / ERD description | Mermaid erDiagram (§6) |
392
- | "Ưu / Nhược", "Pros / Cons", "Trade-offs" | Pros-Cons (§7) |
393
- | "Option A / B / C", "Approaches" | Comparison cards (§8) |
394
- | Kết luận / TL;DR đoạn quan trọng | Key-point highlight (§5) |
395
- | "Lưu ý", "Note", "FYI", "Background" | Callout info (§4a) |
396
- | "Cẩn thận", "Gotcha", "Risk" | Callout warn (§4b) |
397
- | "KHÔNG được", "Tuyệt đối tránh" | Callout danger (§4c) |
398
- | "Đã làm", "Done", "Completed" | Callout success (§4d) |
399
- | "Quyết định", "Decision", "Chose X over Y" | Callout decision (§4e) |
400
- | "Khuyến nghị", "Best practice", "Tip" | Callout tip (§4f) |
401
- | Long code / appendix / FAQ | Collapsible (§9) |
402
- | Bảng so sánh ngắn (≤ 4 cột) | Markdown table (§10) |
403
-
404
- ---
405
-
406
- ## 12. Anti-patterns — đừng làm
407
-
408
- - ❌ Đừng dùng emoji làm icon (ℹ️ ⚠️ ⛔ 🎯 …). Dùng SVG `<use href="#i-...">` từ sprite — emoji render khác nhau giữa OS, không đổi màu theo theme, phá tone minimal.
409
- - ❌ Đừng bọc MỌI thứ vào callout/highlight — loãng hiệu ứng nổi bật.
410
- - ❌ Đừng dùng `<ol>` cho plan steps — dùng `.timeline` thay.
411
- - ❌ Đừng làm mermaid quá phức tạp (> 15 nodes) — split thành nhiều diagram nhỏ.
412
- - ❌ Đừng inline-style — mọi style đều đã ở `template.html`.
413
- - ❌ Đừng quên `id` trên heading — TOC sẽ vỡ, anchor link cũng vỡ.
414
- - ❌ Đừng tự thêm `<script>` hoặc tải thêm thư viện ngoài.
415
- - ❌ Đừng dịch nguyên văn từng dòng Markdown — phải PHÂN TÍCH rồi mới chọn component.
416
- - ❌ Đừng dùng `<h1>` trong body content — `.doc-title` đã là H1; dùng H2/H3 cho section.
417
-
418
- ---
419
-
420
- ## 13. Icon sprite catalog
421
-
422
- `template.html` định nghĩa một SVG sprite với 18 icon Lucide-style. Reference bằng `<use href="#i-NAME"/>`. Icon kế thừa `currentColor` nên màu sẽ tự khớp parent — không cần set `fill` hay `stroke` riêng.
423
-
424
- | Icon ID | Hình | Dùng cho |
425
- |--- |--- |--- |
426
- | `#i-info` | Vòng tròn có chữ "i" | Callout info, background notes |
427
- | `#i-warn` | Tam giác cảnh báo có "!" | Callout warn, risk, gotcha |
428
- | `#i-danger` | Vòng cấm (no entry) | Callout danger, must-not-do |
429
- | `#i-success` | Vòng tròn có dấu check | Callout success, completed |
430
- | `#i-decision` | Bullseye / target | Callout decision, ADR |
431
- | `#i-tip` | Bóng đèn | Callout tip, best practice |
432
- | `#i-lock` | Ổ khoá | Security/auth notes (dùng với callout-info) |
433
- | `#i-printer` | Máy in | Print button (đã trong topbar) |
434
- | `#i-moon` | Mặt trăng | Theme toggle, light mode active |
435
- | `#i-sun` | Mặt trời | Theme toggle, dark mode active |
436
- | `#i-menu` | Hamburger | Mobile TOC trigger (đã trong topbar) |
437
- | `#i-x` | Dấu X | Close drawer / dismiss |
438
- | `#i-file` | File document | doc-meta source file |
439
- | `#i-calendar` | Lịch | doc-meta date |
440
- | `#i-clock` | Đồng hồ | doc-meta read time |
441
- | `#i-copy` | 2 hình vuông xếp lớp | Copy-to-clipboard (auto-inject trên `<pre>`) |
442
- | `#i-check` | Dấu check ✓ | "Copied" state, completed |
443
- | `#i-link` | Link (chain) | Anchor link trên heading (auto-inject) |
444
-
445
- **Standard size**: 18-20px cho callout, 14px cho doc-meta, 16-18px cho topbar button. Set qua CSS `.icon` size hoặc width/height attribute.
446
-
447
- **Khi cần icon không có trong sprite**: KHÔNG tự thêm vào template. Dùng icon gần nghĩa nhất từ catalog. Nếu thật cần icon mới, báo user để bổ sung vào template.
448
-
449
- ---
450
-
451
- ## 14. Edge-case patterns
452
-
453
- ### 14a. Images
454
- ```html
455
- <figure>
456
- <img src="path/to/image.png" alt="Mô tả ngắn gọn nội dung ảnh">
457
- <figcaption>Sơ đồ kiến trúc cluster Kafka 3-broker.</figcaption>
458
- </figure>
459
- ```
460
- - `alt` MUST mô tả nội dung (không viết "image" hoặc bỏ trống). Nếu ảnh decorative → `alt=""`.
461
- - Ảnh tự responsive (`max-width: 100%`), border-radius khớp theme.
462
-
463
- ### 14b. Wide tables (nhiều cột → cần scroll ngang trên mobile)
464
- ```html
465
- <div class="table-wrap">
466
- <table>
467
- <thead>
468
- <tr><th>Col 1</th><th>Col 2</th><th>Col 3</th><th>Col 4</th><th>Col 5</th></tr>
469
- </thead>
470
- <tbody>
471
- <tr><td>...</td><td>...</td><td>...</td><td>...</td><td>...</td></tr>
472
- </tbody>
473
- </table>
474
- </div>
475
- ```
476
- - Wrap trong `.table-wrap` khi bảng có **≥ 4 cột** hoặc cell text dài.
477
- - Bảng đơn giản (≤ 3 cột, text ngắn) có thể dùng `<table>` thường — CSS tự handle overflow-x.
478
-
479
- ### 14c. Task lists (checkboxes)
480
- ```html
481
- <ul>
482
- <li class="task-list-item"><input type="checkbox" class="task-list-item-checkbox" disabled> Việc chưa làm</li>
483
- <li class="task-list-item"><input type="checkbox" class="task-list-item-checkbox" disabled checked> Việc đã làm</li>
484
- </ul>
485
- ```
486
- - Dùng khi source `.md` có `- [ ]` / `- [x]`. Checkbox `disabled` vì HTML chỉ để đọc.
487
-
488
- ### 14d. Footnotes
489
- ```html
490
- <p>Đoạn text có chú thích<sup class="footnote-ref"><a href="#fn1" id="fnref1">1</a></sup>.</p>
491
-
492
- <!-- Cuối document -->
493
- <ol class="footnotes">
494
- <li id="fn1">Nội dung footnote 1. <a href="#fnref1">↩</a></li>
495
- </ol>
496
- ```
497
-
498
- ### 14e. Very long title (≥ 80 chars)
499
- Title tự `text-wrap: balance` và `clamp(28px, ...)` font-size responsive. Không cần làm gì thêm.
500
-
501
- ### 14f. Empty TOC (source không có H2)
502
- JS tự ẩn `<aside class="toc">` khi `#toc-nav` không có link. Không cần làm gì thêm.
503
-
504
- ### 14g. Long URLs / identifiers
505
- `.content` đã có `overflow-wrap: anywhere` — URL/identifier dài tự wrap, không phá layout.
1
+ # md2html — Component Catalog
2
+
3
+ This file is the **single source of truth** for the HTML snippets you (the AI) must use when filling `template.html`.
4
+
5
+ **Rules:**
6
+ - Copy snippets verbatim, only replace the bracketed `{{...}}` placeholders.
7
+ - Never invent new CSS classes — every visual element MUST be one of these components or vanilla markdown HTML (`<h2>`, `<p>`, `<ul>`, etc.).
8
+ - All sample text in this catalog is illustrative — replace with real content from the source `.md`.
9
+ - **Language follows the source**: if source `.md` is English, output English UI labels; if Vietnamese, output Vietnamese. See the label table below. For other languages, use the equivalent translations.
10
+ - **Use SVG icons via the sprite, never emojis.** All icons reference IDs defined in `template.html`'s `<svg class="icon-sprite">`. Form: `<svg class="icon" viewBox="0 0 24 24" aria-hidden="true"><use href="#i-NAME"/></svg>`. See §13 for the full catalog of available icon IDs.
11
+
12
+ ## Language label table
13
+
14
+ The HTML's `<html lang="...">` attribute MUST be set to match the source language (ISO 639-1: `en`, `vi`, `zh`, `ja`, `ko`, `es`, `fr`, `de`, `ru`, `ar`, `th`, …). The "Recommended" badge label is set via the `--rec-label` CSS variable on `<html>` — any language works without CSS edits.
15
+
16
+ ```html
17
+ <!-- example: Chinese source -->
18
+ <html lang="zh" data-theme="light" style="--rec-label: '★ 推荐'">
19
+
20
+ <!-- example: Japanese source -->
21
+ <html lang="ja" data-theme="light" style="--rec-label: '★ 推奨'">
22
+ ```
23
+
24
+ ### Common UI labels by language
25
+
26
+ | Key | EN | VI | ZH (中文) | JA (日本語) | KO (한국어) | ES | FR | DE |
27
+ |--- |--- |--- |--- |--- |--- |--- |--- |--- |
28
+ | `{{TOC_TITLE}}` | Contents | Mục lục | 目录 | 目次 | 목차 | Contenido | Sommaire | Inhalt |
29
+ | `{{REC_LABEL}}` | ★ Recommended | ★ Đề xuất | ★ 推荐 | ★ 推奨 | ★ 추천 | ★ Recomendado | ★ Recommandé | ★ Empfohlen |
30
+ | `{{PRINT_TOOLTIP}}`| Print / Save PDF | In / Lưu PDF | 打印 / 保存 PDF | 印刷 / PDF 保存 | 인쇄 / PDF 저장 | Imprimir / Guardar | Imprimer / PDF | Drucken / PDF |
31
+ | `{{THEME_TOOLTIP}}`| Toggle theme | Đổi theme | 切换主题 | テーマ切替 | 테마 전환 | Cambiar tema | Changer thème | Theme wechseln |
32
+ | Read-time suffix | ~N min read | ~N phút đọc | ~N 分钟阅读 | ~N 分で読了 | ~N분 소요 | ~N min de lectura | ~N min de lecture | ~N Min. Lesezeit |
33
+ | Highlight label | Key point | Ý chính | 要点 | 要点 | 핵심 | Idea clave | Point clé | Kernpunkt |
34
+ | Pros heading | ✓ Pros | ✓ Ưu điểm | ✓ 优点 | ✓ 長所 | ✓ 장점 | ✓ Ventajas | ✓ Avantages | ✓ Vorteile |
35
+ | Cons heading | ✕ Cons | ✕ Nhược điểm | ✕ 缺点 | ✕ 短所 | ✕ 단점 | ✕ Desventajas | ✕ Inconvénients | ✕ Nachteile |
36
+ | Source: prefix | Source: | Nguồn: | 来源: | ソース: | 소스: | Fuente: | Source : | Quelle: |
37
+ | Brand — PLAN | Plan | Kế hoạch | 计划 | 計画 | 계획 | Plan | Plan | Plan |
38
+ | Brand — SPEC | Spec | Đặc tả | 规格 | 仕様 | 사양 | Especificación | Spécification | Spezifikation |
39
+ | Brand — SYSTEM DESIGN | System Design | Thiết kế hệ thống | 系统设计 | システム設計 | 시스템 설계 | Diseño de sistema | Conception système | Systemdesign |
40
+ | Brand — RFC / RUNBOOK / POSTMORTEM | (keep) | (keep) | (keep) | (keep) | (keep) | (keep) | (keep) | (keep) |
41
+ | Brand — BRAINSTORM | Brainstorm | Ý tưởng | 头脑风暴 | ブレスト | 브레인스토밍 | Lluvia de ideas | Brainstorming | Brainstorming |
42
+ | Brand — NOTES | Notes | Ghi chú | 笔记 | メモ | 메모 | Notas | Notes | Notizen |
43
+
44
+ ### Default callout titles (override with source-specific phrases when possible)
45
+
46
+ | Variant | EN | VI | ZH | JA | KO | ES |
47
+ |--- |--- |--- |--- |--- |--- |--- |
48
+ | info | Context | Bối cảnh | 背景 | 背景 | 배경 | Contexto |
49
+ | warn | Heads up | Cảnh báo | 注意 | 注意 | 주의 | Atención |
50
+ | danger | Do not do this | Không được làm | 禁止操作 | 禁止 | 금지 | No hacer |
51
+ | success | Done | Đã hoàn thành | 已完成 | 完了 | 완료 | Hecho |
52
+ | decision | Decision | Quyết định | 决定 | 決定 | 결정 | Decisión |
53
+ | tip | Tip | Gợi ý | 提示 | ヒント | 팁 | Consejo |
54
+
55
+ **Notes:**
56
+ - For a language not listed, translate using the same conventions — every label has a natural equivalent.
57
+ - The "Doc-type eyebrow" (`PLAN`, `SPEC`, `RFC`, `RUNBOOK`, `POSTMORTEM`, `NOTES`) stays as the uppercase English code in **all languages** — it's a universal tag, not a translatable label.
58
+ - Body content (paragraphs, step descriptions, callout bodies, headings H2/H3) is always in the source language — paraphrased but never translated to another language.
59
+ - CJK languages (zh/ja/ko) inherit `font-family: var(--font-sans)` which falls back to system fonts that include CJK glyphs (PingFang on macOS, Microsoft YaHei on Windows, Noto Sans CJK on Linux). No font change needed for correct rendering.
60
+
61
+ ---
62
+
63
+ ## 1. Title block (in `<header class="doc-header">`)
64
+
65
+ Replace `{{TITLE}}`, `{{SUBTITLE}}`, `{{DOC_TYPE}}`, `{{SOURCE_FILE}}`, `{{DATE}}`, `{{READ_TIME}}` in `template.html`.
66
+
67
+ - `{{DOC_TYPE}}` examples: `PLAN`, `SPEC`, `SYSTEM DESIGN`, `RFC`, `NOTES`, `RUNBOOK`, `POSTMORTEM`.
68
+ - `{{READ_TIME}}` format: `~5 phút đọc` (estimate ~250 words/minute).
69
+
70
+ ---
71
+
72
+ ## 2. TOC entry — goes inside `<nav class="toc-nav">`
73
+
74
+ ```html
75
+ <a href="#section-id" class="lvl-2">Tên section</a>
76
+ <a href="#subsection-id" class="lvl-3">Tên sub-section</a>
77
+ ```
78
+
79
+ - One `<a>` per H2/H3 in the document.
80
+ - The `href` must match an `id="..."` on the target heading: `<h2 id="section-id">...</h2>`.
81
+ - Use `class="lvl-2"` for top-level (H2), `class="lvl-3"` for nested (H3). Skip H4 to avoid clutter.
82
+
83
+ ---
84
+
85
+ ## 3. Step card / Timeline
86
+
87
+ For numbered sequences (action items, plan steps, migration steps, workflow). Wrap multiple `.step` in a `.timeline`.
88
+
89
+ ```html
90
+ <div class="timeline">
91
+ <article class="step">
92
+ <div class="step-num">1</div>
93
+ <div class="step-body">
94
+ <h3>Tiêu đề bước</h3>
95
+ <p>Mô tả ngắn gọn 1-2 câu về việc cần làm và lý do.</p>
96
+ <div class="step-tags">
97
+ <span class="tag">backend</span>
98
+ <span class="tag">~2 ngày</span>
99
+ </div>
100
+ </div>
101
+ </article>
102
+ <article class="step">
103
+ <div class="step-num">2</div>
104
+ <div class="step-body">
105
+ <h3>Bước tiếp theo</h3>
106
+ <p>...</p>
107
+ </div>
108
+ </article>
109
+ </div>
110
+ ```
111
+
112
+ - Add `class="step done"` to mark a completed step (circle filled).
113
+ - Tags are optional — use for owner, ETA, area, dependencies.
114
+ - Keep `<h3>` short (≤ 60 chars); detail goes in `<p>`.
115
+
116
+ ---
117
+
118
+ ## 4. Callouts
119
+
120
+ Use for important asides. Pick the variant that matches semantic meaning.
121
+
122
+ ### 4a. Info — context, background, FYI
123
+ ```html
124
+ <aside class="callout callout-info">
125
+ <svg class="callout-icon" viewBox="0 0 24 24" aria-hidden="true"><use href="#i-info"/></svg>
126
+ <div class="callout-body">
127
+ <p class="callout-title">Bối cảnh</p>
128
+ <p>Hệ thống hiện tại dùng cron 5 phút, gây trễ end-to-end ~3 phút.</p>
129
+ </div>
130
+ </aside>
131
+ ```
132
+
133
+ ### 4b. Warning — gotcha, edge case, risk
134
+ ```html
135
+ <aside class="callout callout-warn">
136
+ <svg class="callout-icon" viewBox="0 0 24 24" aria-hidden="true"><use href="#i-warn"/></svg>
137
+ <div class="callout-body">
138
+ <p class="callout-title">Cảnh báo</p>
139
+ <p>Migration này khoá bảng <code>orders</code> ~30s khi chạy production.</p>
140
+ </div>
141
+ </aside>
142
+ ```
143
+
144
+ ### 4c. Danger — blocker, breaking change, must-not-do
145
+ ```html
146
+ <aside class="callout callout-danger">
147
+ <svg class="callout-icon" viewBox="0 0 24 24" aria-hidden="true"><use href="#i-danger"/></svg>
148
+ <div class="callout-body">
149
+ <p class="callout-title">Không được làm</p>
150
+ <p>Tuyệt đối không drop column trước khi rollout deploy cũ.</p>
151
+ </div>
152
+ </aside>
153
+ ```
154
+
155
+ ### 4d. Success — confirmation, what's already done
156
+ ```html
157
+ <aside class="callout callout-success">
158
+ <svg class="callout-icon" viewBox="0 0 24 24" aria-hidden="true"><use href="#i-success"/></svg>
159
+ <div class="callout-body">
160
+ <p class="callout-title">Đã hoàn thành</p>
161
+ <p>API mới đã được test load 10k RPS, p99 = 80ms.</p>
162
+ </div>
163
+ </aside>
164
+ ```
165
+
166
+ ### 4e. Decision — recorded decision / ADR
167
+ ```html
168
+ <aside class="callout callout-decision">
169
+ <svg class="callout-icon" viewBox="0 0 24 24" aria-hidden="true"><use href="#i-decision"/></svg>
170
+ <div class="callout-body">
171
+ <p class="callout-title">Quyết định</p>
172
+ <p>Chọn Postgres thay vì MongoDB vì cần transaction ACID cho luồng thanh toán.</p>
173
+ </div>
174
+ </aside>
175
+ ```
176
+
177
+ ### 4f. Tip — recommendation, best practice
178
+ ```html
179
+ <aside class="callout callout-tip">
180
+ <svg class="callout-icon" viewBox="0 0 24 24" aria-hidden="true"><use href="#i-tip"/></svg>
181
+ <div class="callout-body">
182
+ <p class="callout-title">Gợi ý</p>
183
+ <p>Cache kết quả truy vấn này 5 phút để giảm 80% tải DB.</p>
184
+ </div>
185
+ </aside>
186
+ ```
187
+
188
+ ### 4g. Security — using lock icon for auth/security notes
189
+ ```html
190
+ <aside class="callout callout-info">
191
+ <svg class="callout-icon" viewBox="0 0 24 24" aria-hidden="true"><use href="#i-lock"/></svg>
192
+ <div class="callout-body">
193
+ <p class="callout-title">Bảo mật</p>
194
+ <p>Webhook chạy nội bộ trong VPC, không qua public internet.</p>
195
+ </div>
196
+ </aside>
197
+ ```
198
+
199
+ ---
200
+
201
+ ## 5. Key-point highlight
202
+
203
+ For the single most important insight/conclusion of a section.
204
+
205
+ ```html
206
+ <!-- VI -->
207
+ <div class="highlight">
208
+ <span class="highlight-label">Ý chính</span>
209
+ <p>Tóm lại: chuyển từ polling sang webhook giảm độ trễ từ 3 phút xuống &lt;5s và tiết kiệm 60% lượng API call.</p>
210
+ </div>
211
+
212
+ <!-- EN -->
213
+ <div class="highlight">
214
+ <span class="highlight-label">Key point</span>
215
+ <p>Bottom line: moving from polling to webhooks cuts latency from 3 minutes to &lt;5s and saves 60% of API calls.</p>
216
+ </div>
217
+ ```
218
+
219
+ - Use sparingly (≤ 1 per major section). If everything is highlighted, nothing is.
220
+ - The `highlight-label` text comes from the language label table above.
221
+
222
+ ---
223
+
224
+ ## 6. Mermaid diagram
225
+
226
+ Detect these patterns in source `.md` and convert them:
227
+ - "flow / luồng / step A → step B → step C" → `graph LR` or `flowchart TD`
228
+ - "client gọi server, server gọi DB" → `sequenceDiagram`
229
+ - "table A có FK đến table B" → `erDiagram`
230
+ - "state machine / trạng thái" → `stateDiagram-v2`
231
+ - "phases / roadmap / timeline" → `gantt`
232
+
233
+ ```html
234
+ <figure class="diagram">
235
+ <pre class="mermaid">
236
+ flowchart LR
237
+ A[User] -->|POST /order| B(API Gateway)
238
+ B --> C{Auth?}
239
+ C -->|yes| D[Order Service]
240
+ C -->|no| E[401]
241
+ D --> F[(Postgres)]
242
+ D --> G[/Event bus/]
243
+ </pre>
244
+ <figcaption class="diagram-caption">Luồng tạo đơn hàng từ user đến event bus.</figcaption>
245
+ </figure>
246
+ ```
247
+
248
+ **Mermaid tips for readable output:**
249
+ - Prefer `LR` (left-right) for flows with ≤ 6 nodes, `TD` for vertical hierarchies.
250
+ - Keep node labels short (≤ 3 words). Detail goes in caption.
251
+ - Use `(...)` for service/process, `[...]` for box, `[(...)]` for database, `((...)) ` for circle, `{...}` for decision, `/.../` for queue/event.
252
+ - Always add a `<figcaption>` explaining what the diagram shows.
253
+
254
+ **Convert architecture description to mermaid:**
255
+ > "Client gọi API Gateway. Gateway xác thực JWT, rồi route đến Order Service. Order Service ghi vào Postgres và publish event qua Kafka."
256
+
257
+ Becomes:
258
+ ```
259
+ flowchart LR
260
+ Client --> Gateway
261
+ Gateway -->|verify JWT| Order[Order Service]
262
+ Order --> DB[(Postgres)]
263
+ Order --> Kafka[/Kafka/]
264
+ ```
265
+
266
+ ---
267
+
268
+ ## 7. Pros / Cons table
269
+
270
+ For trade-off discussions ("Option X có ưu/nhược điểm…" / "Trade-offs of X…").
271
+
272
+ ```html
273
+ <!-- VI -->
274
+ <div class="proscons">
275
+ <div class="proscons-col pros">
276
+ <h4>✓ Ưu điểm</h4>
277
+ <ul>
278
+ <li>Triển khai nhanh, không cần thay schema.</li>
279
+ <li>Backward compatible với client cũ.</li>
280
+ </ul>
281
+ </div>
282
+ <div class="proscons-col cons">
283
+ <h4>✕ Nhược điểm</h4>
284
+ <ul>
285
+ <li>Tăng độ phức tạp ở tầng routing.</li>
286
+ <li>Phải maintain 2 đường code trong 1 quý.</li>
287
+ </ul>
288
+ </div>
289
+ </div>
290
+
291
+ <!-- EN -->
292
+ <div class="proscons">
293
+ <div class="proscons-col pros">
294
+ <h4>✓ Pros</h4>
295
+ <ul>
296
+ <li>Fast to ship, no schema change required.</li>
297
+ <li>Backward compatible with existing clients.</li>
298
+ </ul>
299
+ </div>
300
+ <div class="proscons-col cons">
301
+ <h4>✕ Cons</h4>
302
+ <ul>
303
+ <li>Adds complexity to the routing layer.</li>
304
+ <li>Two code paths to maintain for one quarter.</li>
305
+ </ul>
306
+ </div>
307
+ </div>
308
+ ```
309
+
310
+ - The `<h4>` text follows the language label table.
311
+
312
+ ---
313
+
314
+ ## 8. Comparison cards
315
+
316
+ For "Option A vs B vs C" — when there are ≥ 2 alternatives to compare.
317
+
318
+ ```html
319
+ <div class="compare">
320
+ <div class="compare-card recommended">
321
+ <h4>Option B — Hybrid cache</h4>
322
+ <p>Redis L1 + DB fallback. Balances latency and complexity.</p>
323
+ </div>
324
+ <div class="compare-card">
325
+ <h4>Option A — DB only</h4>
326
+ <p>Simplest but p99 latency hits 800ms at peak.</p>
327
+ </div>
328
+ <div class="compare-card">
329
+ <h4>Option C — In-memory map</h4>
330
+ <p>Fastest but loses state on restart, no horizontal scaling.</p>
331
+ </div>
332
+ </div>
333
+ ```
334
+
335
+ - Add `class="recommended"` to the preferred option → ★ badge appears automatically. The badge text comes from `--rec-label` set on `<html style="...">` (see the language table above). Falls back to `★ Recommended` if not set.
336
+ - Put the recommended option **first** so the reader sees it immediately.
337
+ - All body text follows source language — sample above is English; for a Vietnamese / Chinese / Japanese / … source, write descriptions in that language.
338
+
339
+ ---
340
+
341
+ ## 9. Collapsible section
342
+
343
+ For optional / deep-dive content the reader can skip.
344
+
345
+ ```html
346
+ <details class="collapsible">
347
+ <summary>Chi tiết kỹ thuật về sharding strategy</summary>
348
+ <div class="collapsible-body">
349
+ <p>Dùng consistent hashing với 256 virtual nodes per physical shard...</p>
350
+ <pre><code>const shard = hash(userId) % SHARDS;</code></pre>
351
+ </div>
352
+ </details>
353
+ ```
354
+
355
+ **When to collapse:**
356
+ - Long code blocks (> 30 dòng)
357
+ - Background context không phải reader nào cũng cần
358
+ - Alternative approaches đã bị reject
359
+ - Detailed FAQ
360
+
361
+ ---
362
+
363
+ ## 10. Plain Markdown elements
364
+
365
+ These render correctly out-of-the-box with the CSS in `template.html` — just use HTML equivalents:
366
+
367
+ | Markdown | HTML to write |
368
+ |---|---|
369
+ | `## Heading` | `<h2 id="kebab-case-id">Heading</h2>` |
370
+ | `### Sub` | `<h3 id="kebab-case-id">Sub</h3>` |
371
+ | `**bold**` | `<strong>bold</strong>` |
372
+ | `inline code` | `<code>inline code</code>` |
373
+ | ```` ```js code``` ```` | `<pre><code>js code</code></pre>` |
374
+ | `- item` | `<ul><li>item</li></ul>` |
375
+ | `1. item` | `<ol><li>item</li></ol>` (chỉ dùng khi KHÔNG phải timeline) |
376
+ | `> quote` | `<blockquote>quote</blockquote>` |
377
+ | `--- table ---` | `<table>...</table>` |
378
+ | `[text](url)` | `<a href="url">text</a>` |
379
+
380
+ ---
381
+
382
+ ## 11. Component selection cheatsheet
383
+
384
+ Áp dụng heuristics này khi đọc source `.md`:
385
+
386
+ | Pattern trong source | Component nên dùng |
387
+ |---|---|
388
+ | Numbered list of action items (`1. làm X`, `2. làm Y`) | Step / Timeline (§3) |
389
+ | Architecture description với A gọi B gọi C | Mermaid flowchart (§6) |
390
+ | "Client → Server → DB" trong text | Mermaid sequence/flow (§6) |
391
+ | Schema / ERD description | Mermaid erDiagram (§6) |
392
+ | "Ưu / Nhược", "Pros / Cons", "Trade-offs" | Pros-Cons (§7) |
393
+ | "Option A / B / C", "Approaches" | Comparison cards (§8) |
394
+ | Kết luận / TL;DR đoạn quan trọng | Key-point highlight (§5) |
395
+ | "Lưu ý", "Note", "FYI", "Background" | Callout info (§4a) |
396
+ | "Cẩn thận", "Gotcha", "Risk" | Callout warn (§4b) |
397
+ | "KHÔNG được", "Tuyệt đối tránh" | Callout danger (§4c) |
398
+ | "Đã làm", "Done", "Completed" | Callout success (§4d) |
399
+ | "Quyết định", "Decision", "Chose X over Y" | Callout decision (§4e) |
400
+ | "Khuyến nghị", "Best practice", "Tip" | Callout tip (§4f) |
401
+ | Long code / appendix / FAQ | Collapsible (§9) |
402
+ | Bảng so sánh ngắn (≤ 4 cột) | Markdown table (§10) |
403
+
404
+ ---
405
+
406
+ ## 12. Anti-patterns — đừng làm
407
+
408
+ - ❌ Đừng dùng emoji làm icon (ℹ️ ⚠️ ⛔ 🎯 …). Dùng SVG `<use href="#i-...">` từ sprite — emoji render khác nhau giữa OS, không đổi màu theo theme, phá tone minimal.
409
+ - ❌ Đừng bọc MỌI thứ vào callout/highlight — loãng hiệu ứng nổi bật.
410
+ - ❌ Đừng dùng `<ol>` cho plan steps — dùng `.timeline` thay.
411
+ - ❌ Đừng làm mermaid quá phức tạp (> 15 nodes) — split thành nhiều diagram nhỏ.
412
+ - ❌ Đừng inline-style — mọi style đều đã ở `template.html`.
413
+ - ❌ Đừng quên `id` trên heading — TOC sẽ vỡ, anchor link cũng vỡ.
414
+ - ❌ Đừng tự thêm `<script>` hoặc tải thêm thư viện ngoài.
415
+ - ❌ Đừng dịch nguyên văn từng dòng Markdown — phải PHÂN TÍCH rồi mới chọn component.
416
+ - ❌ Đừng dùng `<h1>` trong body content — `.doc-title` đã là H1; dùng H2/H3 cho section.
417
+
418
+ ---
419
+
420
+ ## 13. Icon sprite catalog
421
+
422
+ `template.html` định nghĩa một SVG sprite với 18 icon Lucide-style. Reference bằng `<use href="#i-NAME"/>`. Icon kế thừa `currentColor` nên màu sẽ tự khớp parent — không cần set `fill` hay `stroke` riêng.
423
+
424
+ | Icon ID | Hình | Dùng cho |
425
+ |--- |--- |--- |
426
+ | `#i-info` | Vòng tròn có chữ "i" | Callout info, background notes |
427
+ | `#i-warn` | Tam giác cảnh báo có "!" | Callout warn, risk, gotcha |
428
+ | `#i-danger` | Vòng cấm (no entry) | Callout danger, must-not-do |
429
+ | `#i-success` | Vòng tròn có dấu check | Callout success, completed |
430
+ | `#i-decision` | Bullseye / target | Callout decision, ADR |
431
+ | `#i-tip` | Bóng đèn | Callout tip, best practice |
432
+ | `#i-lock` | Ổ khoá | Security/auth notes (dùng với callout-info) |
433
+ | `#i-printer` | Máy in | Print button (đã trong topbar) |
434
+ | `#i-moon` | Mặt trăng | Theme toggle, light mode active |
435
+ | `#i-sun` | Mặt trời | Theme toggle, dark mode active |
436
+ | `#i-menu` | Hamburger | Mobile TOC trigger (đã trong topbar) |
437
+ | `#i-x` | Dấu X | Close drawer / dismiss |
438
+ | `#i-file` | File document | doc-meta source file |
439
+ | `#i-calendar` | Lịch | doc-meta date |
440
+ | `#i-clock` | Đồng hồ | doc-meta read time |
441
+ | `#i-copy` | 2 hình vuông xếp lớp | Copy-to-clipboard (auto-inject trên `<pre>`) |
442
+ | `#i-check` | Dấu check ✓ | "Copied" state, completed |
443
+ | `#i-link` | Link (chain) | Anchor link trên heading (auto-inject) |
444
+
445
+ **Standard size**: 18-20px cho callout, 14px cho doc-meta, 16-18px cho topbar button. Set qua CSS `.icon` size hoặc width/height attribute.
446
+
447
+ **Khi cần icon không có trong sprite**: KHÔNG tự thêm vào template. Dùng icon gần nghĩa nhất từ catalog. Nếu thật cần icon mới, báo user để bổ sung vào template.
448
+
449
+ ---
450
+
451
+ ## 14. Edge-case patterns
452
+
453
+ ### 14a. Images
454
+ ```html
455
+ <figure>
456
+ <img src="path/to/image.png" alt="Mô tả ngắn gọn nội dung ảnh">
457
+ <figcaption>Sơ đồ kiến trúc cluster Kafka 3-broker.</figcaption>
458
+ </figure>
459
+ ```
460
+ - `alt` MUST mô tả nội dung (không viết "image" hoặc bỏ trống). Nếu ảnh decorative → `alt=""`.
461
+ - Ảnh tự responsive (`max-width: 100%`), border-radius khớp theme.
462
+
463
+ ### 14b. Wide tables (nhiều cột → cần scroll ngang trên mobile)
464
+ ```html
465
+ <div class="table-wrap">
466
+ <table>
467
+ <thead>
468
+ <tr><th>Col 1</th><th>Col 2</th><th>Col 3</th><th>Col 4</th><th>Col 5</th></tr>
469
+ </thead>
470
+ <tbody>
471
+ <tr><td>...</td><td>...</td><td>...</td><td>...</td><td>...</td></tr>
472
+ </tbody>
473
+ </table>
474
+ </div>
475
+ ```
476
+ - Wrap trong `.table-wrap` khi bảng có **≥ 4 cột** hoặc cell text dài.
477
+ - Bảng đơn giản (≤ 3 cột, text ngắn) có thể dùng `<table>` thường — CSS tự handle overflow-x.
478
+
479
+ ### 14c. Task lists (checkboxes)
480
+ ```html
481
+ <ul>
482
+ <li class="task-list-item"><input type="checkbox" class="task-list-item-checkbox" disabled> Việc chưa làm</li>
483
+ <li class="task-list-item"><input type="checkbox" class="task-list-item-checkbox" disabled checked> Việc đã làm</li>
484
+ </ul>
485
+ ```
486
+ - Dùng khi source `.md` có `- [ ]` / `- [x]`. Checkbox `disabled` vì HTML chỉ để đọc.
487
+
488
+ ### 14d. Footnotes
489
+ ```html
490
+ <p>Đoạn text có chú thích<sup class="footnote-ref"><a href="#fn1" id="fnref1">1</a></sup>.</p>
491
+
492
+ <!-- Cuối document -->
493
+ <ol class="footnotes">
494
+ <li id="fn1">Nội dung footnote 1. <a href="#fnref1">↩</a></li>
495
+ </ol>
496
+ ```
497
+
498
+ ### 14e. Very long title (≥ 80 chars)
499
+ Title tự `text-wrap: balance` và `clamp(28px, ...)` font-size responsive. Không cần làm gì thêm.
500
+
501
+ ### 14f. Empty TOC (source không có H2)
502
+ JS tự ẩn `<aside class="toc">` khi `#toc-nav` không có link. Không cần làm gì thêm.
503
+
504
+ ### 14g. Long URLs / identifiers
505
+ `.content` đã có `overflow-wrap: anywhere` — URL/identifier dài tự wrap, không phá layout.