Repository navigation
docs: update bilingual guides and v1.1.0 changelog - #27
Conversation
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: c157cd72cf
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
Codex Review SummaryThis comment shows the latest Codex review activity on this pull request.
ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings. |
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 4021a48e03
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
| <h2>Adapter checklist</h2> | ||
| <ul><li>Publish a stable lowercase adapter name and version.</li><li>Keep IDs, roles, parents, states, and supported actions consistent.</li><li>Use the host's real input/listener path and always emit success or failure.</li><li>Never copy sensitive values into logs, diagnostics, or completion events.</li><li>Distinguish headless, rendering-disabled, and stale screenshot outcomes.</li><li>Dispose the runtime to release the bridge and native handle.</li></ul> | ||
| <h2 id="observe">Register typed Observe values</h2><p>Use <code>Gua.Runtime</code> for registration and <code>Gua.Core</code> for Values and enum catalogs. Register only on an already published UI/Object owner, keep registration tokens alive with the game object, and dispose them when it is removed. Player publication is explicitly opted in and remains subject to host projection.</p> | ||
| <CodeBlock title="Register an enum on a published World object" lang="csharp" code={"using Gua.Core;\nusing Gua.Runtime;\n\n// Publish the World owner \"enemy-1\" before registering its values.\nusing var catalog = new GuaEnumCatalog();\ncatalog.Register(\"game.Phase\", \"First\", \"Second\");\nusing var owner = runtime.CreateObserveOwner(GuaObserveSource.Object, \"enemy-1\");\nusing var phase = owner.Observe(\"phase\",\n () => GuaValue.Enum(\"game.Phase\", enemy.Phase, catalog), allowPlayer: true);\n// Keep owner, phase, and catalog alive with the game object.\n// Normal World publication samples the getter; phase.Notify() is explicit notification."} /> |
There was a problem hiding this comment.
Keep Observe registrations alive beyond setup
When this example is placed in a normal initialization method, all three using var declarations are disposed as soon as that method returns, so the Observe registration is immediately removed even though the surrounding text says to retain it for the game object's lifetime. The mirrored Japanese example has the same problem. Store the catalog, owner, and registration token in long-lived fields and dispose them when the associated object is removed.
Useful? React with 👍 / 👎.
The website mixed package selection with release history and assumed familiarity with protocol terms. Separate the v1.1.0 changelog from the regular guides, explain all four public npm packages through concrete tasks, and make the bilingual entry pages easier to follow.
v1.1.0. Compare the actual preceding published release v1.0.10 with v1.1.0; distinguish additions, changed behavior, fixes, and pre-existing capabilities. Link the source comparison and relevant released PRs. Keep historical v1.1.0 limits separate from later v1.1.1 verification.gui-mcp,gua-webmcp,gua-value-tools, andgua-world-tools: roles, installation, dependencies, combinations, and inputs/outputs. Explain typed Value versus World object data using an inventory set and an unlocked-door selector. Use responsive package cards on mobile.Normal installation continues to describe published Godot ZIP, Unity UPM, and Inspector assets. Temporary distribution incident status and old candidate package identities are excluded from enduring guides. Publication, merge, and deployment are outside this change.
Historical source comparison:
gua-v1.0.10(10a8ef71713fe491633cf2b5649c76007cfd4767) →gua-v1.1.0(968259fbe675bca03cf8c8ef5a3179c7741215a0). The cumulative website diff is against14bde67a9fd6bc6390e78733949d93a173ca3709.Validation for final documentation head
4021a48e036db7b9224c721f7f4eefacdd575326:Astro build/check: 74 files, zero errors/warnings/hints; 60 generated pages.
bun test: 4 passed. Cumulativegit diff --checkpassed; clean worktree.All 2,168 internal link/anchor occurrences across 60 pages checked.
Value/World examples executed against tagged source. The action/wait calls compiled against published
Gua.Testing1.1.0 with zero warnings/errors; this checks API usage, not game execution.Chrome: 96 desktop/mobile renders across all 48 cumulative changed EN/JA routes passed at
69c22ac. After review fixes, all four affected EN/JA state/npm routes were rechecked at the final head in 8 renders; links, anchors, source targets, language counterparts, overflow, and browser errors passed. An additional 16 viewport captures and mobile changelog navigation checks passed; revised layouts were visually inspected.Independent read-only cumulative review and one final fix-only pass: both verified findings resolved; no actionable findings remain.
Exact final-head CI: locked install, tests, and Astro build all passed at
4021a48.No native runtime, engine, hardware, release, or registry-publication test is claimed. The existing main-only Pages deployment workflow is unchanged.