Restructure README: video, collapsible sections, expanded docs#7
Merged
Conversation
- Embed the YouTube tutorial as a clickable thumbnail under the header - Collapsible install methods (OpenUPM CLI, Git URL with version pinning, manual scoped registry) - Collapsible attribute docs with new section for [SingletonInclude] / [SingletonIgnore] - Document [Singleton]'s destroyOnLoad flag and generated members - Move "Swapping in tests" and "Lazy instantiation" under a Guidance subsection - Add shields.io badges, GitHub callouts, and section separators for readability
GitHub renders [!NOTE]/[!TIP]/[!WARNING] callouts only at the markdown's top level, not inside <details> blocks, so the two inside collapsibles were falling through as plain quotes.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
<details>blocks so the page reads as a TOC at a glance.[SingletonInclude]/[SingletonIgnore]section, document[Singleton]'sdestroyOnLoadoption, and add a "Generated members" table.### Guidancesubsection so they're no longer siblings of the attribute docs.---separators to break up the wall of text.# MGenerators(matchesmain); bundle IDgames.engine-room.generatorsis untouched.Test plan
<details>block and check that code fences, tables, and> [!TIP]/> [!NOTE]/> [!WARNING]callouts render correctly.#v1.0.0) actually resolve in Unity's Package Manager.