Skip to content

docs: document canonical server-minted world IDs - #180

Merged
EthanThatOneKid merged 2 commits into
mainfrom
task/world-identity-docs-20260929
Oct 10, 2026
Merged

EthanThatOneKid merged 2 commits into
mainfrom
task/world-identity-docs-20260929

Conversation

@EthanThatOneKid

Copy link
Copy Markdown
Contributor

Scope

Document the single server-minted world-identity contract across the console quickstart, Worlds API, @wazoo/client and @worlds/client guides, CLI examples, and Wazoo skill instructions. World creation takes a display name; the Worlds API returns world.id in w_<UUIDv4> form; clients reuse that exact value as worldId in world paths.

Scope boundary

This PR changes only World identity examples and explanations. It excludes non-world id/<entity>_id normalization, API-key/token examples, broad OpenAPI snapshots, and drift guards; those remain in workspace#148. It does not merge/publish/deploy any API or SDK.

Dependencies

Keep this draft until those contracts are reviewed and shipped.

Verification

  • npm ci --no-audit --no-fund — passed
  • npm run precommit — passed (format and docs build)
  • npx mintlify broken-links — passed
  • git diff --check — passed

@wazoocomputer

wazoocomputer Bot commented Sep 29, 2026

Copy link
Copy Markdown

This pull request updates the documentation to reflect that world IDs are now server-minted, immutable w_<UUIDv4> values, rather than user-selected. This change impacts how world IDs are created and referenced across the console quickstart, Worlds API, Wazoo client libraries, CLI examples, and Wazoo skill instructions.

File Change Summary
getting-started.mdx modified Update world creation flow to reflect server-minted IDs.
guides/company-brain.mdx modified Update CLI examples to use server-minted WORLD_ID.
guides/entity-resolution.mdx modified Update curl examples to use server-minted worldId.
platform/api.mdx modified Document w_<UUIDv4> world ID format and creation.
platform/typescript-sdk.mdx modified Update TypeScript SDK examples to use server-minted worldId.
projects/worlds.mdx modified Update curl examples for world creation and token minting to use server-minted WORLD_ID.
quickstart.mdx modified Update quickstart guide to reflect server-minted world IDs.
reference/cli/usage.mdx modified Update CLI usage examples to use server-minted worldId.
reference/cli/worlds.mdx modified Update CLI worlds command examples to use server-minted worldId.
skills/wazoo.mdx modified Add note about server-minted world IDs.
worlds/client.mdx modified Update @worlds/client examples to use world.id and worldId parameter.
worlds/query.mdx modified Update curl example to use server-minted worldId.
worlds/search.mdx modified Update curl example to use server-minted worldId and revise search explanation.
worlds/update.mdx modified Update curl examples to use server-minted worldId.

Reviewers should begin by examining platform/api.mdx to understand the core change in world ID handling.

@EthanThatOneKid
EthanThatOneKid marked this pull request as ready for review October 10, 2026 17:36
@EthanThatOneKid
EthanThatOneKid merged commit da097ec into main Oct 10, 2026
4 checks passed
@EthanThatOneKid
EthanThatOneKid deleted the task/world-identity-docs-20260929 branch October 10, 2026 17:36
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