Skip to content

docs: update bilingual guides and v1.1.0 changelog - #27

Merged
link1345 merged 9 commits into
mainfrom
docs/reference-110
Oct 6, 2026
Merged

link1345 merged 9 commits into
mainfrom
docs/reference-110

Conversation

@link1345

@link1345 link1345 commented Oct 5, 2026 •

Copy link
Copy Markdown
Collaborator

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.

  • Add a separate Changelog / 更新履歴 navigation category with the link label 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.
  • Add EN/JA npm package guides covering gui-mcp, gua-webmcp, gua-value-tools, and gua-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.
  • Rename the Value page and navigation to Value tools / Valueツール. Lead with a practical comparison, then installation and precise API details. Keep package selection in the normal .NET/npm guides.
  • Address issue #20: simplify the shared state/action/wait page with a click-and-wait example, an ownership diagram, plain definitions of update counters, completion versus resulting state, condition versus fixed-time waits, input ownership/cleanup, MCP/WebMCP differences, and the AI conversation/ reasoning boundary. All five requested related guide families link to the shared page in both languages.
  • Preserve the cumulative canonical-guide updates for semantic Snapshots, Observe, Trace, locator action waits, explicit lint, physics queries, input metadata, Timed Segment replay, and Inspector. Homepages, World guides, and package-reference links now lead to the appropriate ordinary guide instead of a duplicated package-selection release page.

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 against 14bde67a9fd6bc6390e78733949d93a173ca3709.

Validation for final documentation head 4021a48e036db7b9224c721f7f4eefacdd575326:

  • Astro build/check: 74 files, zero errors/warnings/hints; 60 generated pages.

  • bun test: 4 passed. Cumulative git diff --check passed; 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.Testing 1.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.

@link1345 link1345 changed the title docs: backfill verified Gua 1.1.0 references docs: guide package choices and features in Gua 1.1.0 Oct 5, 2026
@link1345
link1345 marked this pull request as ready for review October 5, 2026 02:50

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 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".

Comment thread src/layouts/BaseLayout.astro
@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Oct 5, 2026 •

Copy link
Copy Markdown

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review ✅ Completed 2026-10-06T00:09:56.564374Z 4021a48 New commits
ℹ️ 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" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

@link1345 link1345 changed the title docs: guide package choices and features in Gua 1.1.0 docs: update canonical guides and installation for Gua 1.1.0 Oct 5, 2026
@link1345 link1345 changed the title docs: update canonical guides and installation for Gua 1.1.0 docs: update bilingual guides and v1.1.0 changelog Oct 6, 2026

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 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."} />

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge 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 👍 / 👎.

@link1345
link1345 merged commit 4fc45d6 into main Oct 6, 2026
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant