Skip to content

Extract Types/Ids/SerializeReferences references and rework READMEs - #146

Draft
VPDPersonal wants to merge 15 commits into
mainfrom
docs/types-reference-overhaul
Draft

Extract Types/Ids/SerializeReferences references and rework READMEs#146
VPDPersonal wants to merge 15 commits into
mainfrom
docs/types-reference-overhaul

Conversation

@VPDPersonal

@VPDPersonal VPDPersonal commented Jul 19, 2026

Copy link
Copy Markdown
Owner

Summary

  • 📝 Extract self-contained EN/RU references out of the oversized READMEs — Types.md, Ids.md, SerializeReferences.md, plus SerializeReferenceTooling.md for the project-wide side (bulk-repair tabs, project settings, build/CI gate, headless CI); drop the "— full reference" title suffix across all reference docs
  • 📝 Rework all four READMEs around the extracted references (833 → ~640 lines each): new intro, polished TOC blurbs, the Serializable Type System section mirrored 1:1 against Types.md, sample callouts removed
  • 🖼️ New picker media: TypeSelectorDisplay / Required screenshots and an open-generic picking GIF; re-shot SerializableType, ComponentTypeSelector and the picker window
  • 🖼️ New SerializeReferences media: inspector picker GIF, missing-type repair and shared-reference Make unique notices, Asset References / Project References tab screenshots — applied to both locales
  • 🔧 DevTests DocsMedia harness backing the shots: Game.Combat demo types (incl. GenericEffects for the open-generic GIF) and the SerializeReferences prefab set (WeaponPreset, SharedWeaponPreset, BrokenWeaponPreset)
  • 🔧 Housekeeping: sync-readmes skill updated (sixteen READMEs, new per-feature list, stale StringIdRegistry note dropped); derivable trees trimmed out of the Generators / Ids CLAUDE.md

Notes for review

  • ⚠️ The picker's generic-argument page lists only [Serializable] candidates — the demo status effects carry the attribute for exactly that reason
  • 📝 The README's Serializable Type System section is intentionally a verbatim subset of Types.md (intro, full feature list, media), so future edits should land in Types.md first and be mirrored
  • ♻️ main is merged in a few times (the analyzer submodule → subtree move landed there mid-branch); the diff against main itself stays docs-only
🇷🇺 Описание на русском

Кратко

  • 📝 Полные справочники EN/RU вынесены из разросшихся README — Types.md, Ids.md, SerializeReferences.md, плюс SerializeReferenceTooling.md под проектную часть (вкладки массового ремонта, настройки проекта, build/CI-гейт, headless CI); у всех справочников снят суффикс «— full reference»
  • 📝 Все четыре README переработаны вокруг вынесенных справочников (833 → ~640 строк): новое интро, отполированное оглавление, раздел Serializable Type System зеркалит Types.md один в один, колауты сэмплов убраны
  • 🖼️ Новые медиа пикера: скриншоты TypeSelectorDisplay / Required и гифка выбора открытого generic; переcняты SerializableType, ComponentTypeSelector и окно пикера
  • 🖼️ Новые медиа SerializeReferences: гифка выбора типа в инспекторе, уведомления о починке пропавшего типа и Make unique для общей ссылки, скриншоты вкладок Asset References / Project References — в обеих локалях
  • 🔧 Обвязка DocsMedia в DevTests под съёмку: демо-типы Game.Combat (включая GenericEffects для generic-гифки) и набор префабов SerializeReferences (WeaponPreset, SharedWeaponPreset, BrokenWeaponPreset)
  • 🔧 Мелочи: обновлён скилл sync-readmes (шестнадцать README, новый список справочников, убрано устаревшее упоминание StringIdRegistry); из CLAUDE.md Generators и Ids вычищено выводимое из кода

Заметки для ревью

  • ⚠️ Страница выбора generic-аргумента показывает только [Serializable]-кандидатов — демо-статус-эффекты несут атрибут именно поэтому
  • 📝 Раздел Serializable Type System в README — намеренно дословное подмножество Types.md: правки сначала в Types.md, затем зеркалить
  • ♻️ main вливался в ветку несколько раз (в него по ходу дела приехал перевод анализатора из сабмодуля в subtree); сам дифф относительно main остаётся docs-only

VPDPersonal and others added 3 commits July 20, 2026 01:37
- add self-contained EN/RU references for the Serializable Type System, ID System and SerializeReference Selector, extracted from the READMEs
- drop the "— full reference" title suffix across all reference docs
- add picker media: TypeSelectorDisplay/Required screenshots, an open-generic picking GIF, re-shot SerializableType/ComponentTypeSelector/window shots

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01SuJE65oWmemhK78zC7NfUq
- rewrite the intro and polish the TOC blurbs
- mirror the Serializable Type System section against Types.md: full TypeSelectorWindow feature list, Script-row note, generic-picking GIF
- replace the TypeSelectorAttribute mechanics paragraph with reference links; drop sample callouts

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01SuJE65oWmemhK78zC7NfUq
- Game.Combat harness (Weapons, Loadout, CombatModifiers, WeaponMount, GenericEffects) backing the Types.md screenshots and the open-generic GIF
- update the sync-readmes skill

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01SuJE65oWmemhK78zC7NfUq
@VPDPersonal VPDPersonal added type: documentation Documentation only status: work-in-progress Draft / not ready for review area: claude Claude Code automation (.claude/ skills, agents, hooks) area: docs Repository documentation (README, CHANGELOG, docs/) labels Jul 19, 2026
VPDPersonal and others added 12 commits July 20, 2026 01:59
- fix README count from fourteen/10-sample to sixteen/12-sample (SerializeReferences sample folder was missing)
- drop stale StringIdRegistry mention — the type no longer exists in the codebase

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01Jf8Kdz9hobr77ckjYddJRn
…dates

- explain in the TypeSelectorWindow section (EN + RU) that the generic argument page only lists types Unity can serialize as a field value (primitives, enum, string, UnityEngine.Object refs, [Serializable] classes/structs)

Co-Authored-By: Claude <noreply@anthropic.com>
…overhaul

# Conflicts:
#	Aspid.FastTools/Packages/tech.aspid.fasttools/Documentation/EN/README.md
#	Aspid.FastTools/Packages/tech.aspid.fasttools/Documentation/RU/README.md
#	README.md
#	README_RU.md
- reword the [SerializeReference] example comment: picking a type creates
  an instance and assigns it to the field (no misleading "stores the type")
- explain Required = true inline: inspector warning plus build/CI-gate violation
- applied to all six synced copies (root/Documentation READMEs and Types.md, EN/RU)

Co-Authored-By: Claude <noreply@anthropic.com>
- add "Inspector type dropdown" media: picker GIF, missing-type repair
  and shared-reference Make unique notices
- add "Bulk repair tabs" screenshots: Asset References and Project References
- applied to both EN and RU copies

Co-Authored-By: Claude <noreply@anthropic.com>
Co-Authored-By: Claude <noreply@anthropic.com>
- drop the Generators solution-structure tree and TypeData/IdStructData reference copies (ls and the sources show them)
- replace the Ids directory tree with a two-sentence layout summary keeping the non-obvious facts

Co-Authored-By: Claude <noreply@anthropic.com>
…ReferenceTooling.md

- move Bulk repair tabs, Project settings & build/CI gate and Headless CI sections out of SerializeReferences.md into a new SerializeReferenceTooling.md (EN/RU) with .meta files
- SerializeReferences.md now covers only the Inspector side; intro, section list and Required/gate links repointed to the new doc
- Types.md Required notice now links the fix instructions in the new doc; all 4 README footers link both references
- register the new doc in the sync-readmes skill's per-feature list

Co-Authored-By: Claude <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area: claude Claude Code automation (.claude/ skills, agents, hooks) area: docs Repository documentation (README, CHANGELOG, docs/) status: work-in-progress Draft / not ready for review type: documentation Documentation only

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant