style: apply /style-guide pass to models/registry

[johndmulhausen]

Summary

This PR applies the /style-guide skill (Google Developer Style Guide + CoreWeave conventions) to the models/registry section. The run was automated; all edits are style-only and require human review before merge.

Files edited

• models/registry/aliases.mdx
• models/registry/configure_registry.mdx
• models/registry/create_collection.mdx
• models/registry/create_registry.mdx
• models/registry/delete_registry.mdx
• models/registry/download_use_artifact.mdx
• models/registry/lineage.mdx
• models/registry/link_version.mdx
• models/registry/organize-with-tags.mdx
• models/registry/registry_cards.mdx
• models/registry/search_registry.mdx

Recommendations for technical review

Prerequisites

• Most pages lack a dedicated Prerequisites section. Confirm whether to add one covering required role/permissions (registry admin, team access), W&B Python SDK install + wandb login authentication, and any Server version gates — applies to aliases.mdx, configure_registry.mdx, create_collection.mdx, create_registry.mdx, download_use_artifact.mdx, link_version.mdx, organize-with-tags.mdx, registry_cards.mdx.
• lineage.mdx: confirm whether viewer-level access is sufficient to view lineage graphs and Action History, or whether Registry admin/member roles are required.
• organize-with-tags.mdx: the intro Note compares tags to aliases without linking to the aliases doc — consider adding the link.

Verification steps

• Across nearly every file, procedures (UI and SDK) end without describing the expected outcome. Confirm and add brief "Result:" lines — for example, where a created/deleted/linked object appears in the UI, the return value of SDK calls such as create_registry(), fetched_registry.delete(), collection.save(), and link_artifact().
• aliases.mdx: the "Find existing aliases" procedure does not describe what an unsuccessful search looks like.
• organize-with-tags.mdx: add verification snippets (e.g., re-fetch collection.tags) after add/update/remove tag examples, and confirm whether .save() is implicitly required for the update flows.

Technical accuracy

• aliases.mdx: confirm whether entity value smle-reg-team-2 in the Example is intentional or should be a placeholder; verify the #custom-aliases cross-reference for "non protected alias" on line 54.
• configure_registry.mdx: verify UI labels (both Add access buttons in steps 4 and 6), the Service account (non-admin) vs. User or service account (non-admin) row overlap, the Multi-tenant Cloud "Restricted Viewer" version qualifier, the cross-registry access summary wording, and the lone #### SDK compatibility H4. Normalize bare URLs across the three procedures and verify the raw <sup><a> footnote markup renders in Mintlify.
• create_collection.mdx: print(artifact_type.name for artifact_type in artifact_types) on line 95 prints a generator object — likely a bug. Confirm the "Python SDK (Beta)" tab label is still current; verify wandb.Api().project(...).artifact_types() signature and .name attribute; confirm the target_path format wandb-registry-{registry_name}/{collection_name} (some docs include an entity prefix); clarify how artifact type is determined when link_artifact auto-creates a collection; verify the UI label ("Artifact" vs. "Artifact collection") and the correct term for artifact-type indicators on the registry card.
• create_registry.mdx: broken anchor on line 87 — ./create_registry#create-a-custom-registry does not exist (only #create-a-registry). Confirm whether registry visibility is exhaustively two options (Restricted, Organization). Consider promoting the line-43 <Note> about irreversible artifact-type saves to a <Warning>.
• delete_registry.mdx: confirm whether api.registry("[REGISTRY-NAME]") requires an organization/entity scope in addition to the name.
• download_use_artifact.mdx: confirm the path template wandb-registry-{REGISTRY}/{COLLECTION}:{ALIAS} and the preferred reference form (wandb.Run.use_artifact() vs. run.use_artifact()). The <Note> block on lines 98–114 contains a possibly redundant second wandb.Api() instantiation — confirm whether it's intentional. Confirm the mixed f-string {REGISTRY} vs. angle-bracket <registry_name> placeholder convention is intentional.
• lineage.mdx: confirm exact UI elements — step 3 "From the dropdown" is ambiguous, and verify Action History capitalization. Decide whether to restore or remove the commented-out block at lines 84–88.
• link_version.mdx: verify the renumbered W&B Registry tab (now 8 steps) didn't drop a step at the original duplicate 5.; confirm step order in the Artifact browser tab; consider splitting the recovery instruction at step 3 of Log from a team entity out of the numbered list; confirm the Select a register model UI label spelling (register vs. registry). Decide whether the four commented-out <Note> blocks (lines 28–30, 34–36, 47–49, 165–170) should be surfaced or deleted.
• organize-with-tags.mdx: the artifact-version View tags SDK example uses lowercase artifact_type while ARTIFACT_TYPE is defined above — likely a bug. The collection.tags = set(collection.tags) - set(tags_to_delete) pattern references an undefined tags_to_delete and assigns a set where the attribute may expect a list. collection.tags = ["your-tag"] overwrites rather than appends — confirm whether section title "Add a tag" matches behavior. Verify wandb.Api().artifact_collection and wandb.Api().artifact signatures. The hardcoded https://wandb.ai/registry URL needs a Dedicated Cloud / self-managed caveat.
• registry_cards.mdx: line 12 "Summary" bullet is two fragments — combine or split. Confirm the Pass-8 inferences on line 23 ("Task") and line 19 ("Data storage") match original meaning; confirm the View details UI label; reconcile the wandb-registry vs. wandb-registry-[REGISTRY-NAME] prefix on lines 41/44; confirm the [COLLECTION-TYPE] placeholder for type_name and link to accepted values.
• search_registry.mdx: lines 140–158 alias mismatch — Pass 8 changed prose latest → production to match the code sample; confirm which value is intended. Verify the API accepts mixed timestamp precision ("2024-01-08" vs. "2025-03-04 13:10:00"). Reword operator descriptions like "Performs AND logic to one or more conditions" ("to" → "on" or "against"). Add expected-value type or example for $exists (line 85). Verify the renamed link target on line 172 (/models/ref/python/experiments/artifact/) is titled "Artifact".

Missing content

• aliases.mdx: consider promoting the H3 ### Protected aliases (currently nested inside ## Custom aliases) to its own H2; the "Create a protected alias" subsection has two consecutive procedures — confirm whether they're distinct workflows.
• configure_registry.mdx: no link or definition for "Organization or Restricted" registry visibility; "Inherited registry role" examples reference team roles without linking to team-role docs; verify no other pages still link to the old #registry-role-permissions anchor (replaced by #role-permissions).
• create_collection.mdx: no troubleshooting beyond the artifact-type-mismatch Note; no cross-link to a "link an artifact to a collection" page; "Collection types" doesn't link to registry-level artifact-type configuration.
• delete_registry.mdx: line 14 references "collections" and "artifacts linked to the registry" without cross-links to concept pages.
• lineage.mdx: artifacts, runs, collections, and aliases are referenced without inline definitions or links.
• link_version.mdx: the intro mentions "private, project-level scope to a shared, organization-level scope" without defining organization vs. team entity until Troubleshooting; the Find your team entity "Copy the site's URL" instruction doesn't say where to paste it.
• organize-with-tags.mdx: no documentation of tag naming constraints (allowed characters, length, case, uniqueness scope), permissions for adding/removing tags, or interactions with automations/webhooks/lineage; consider whether SDK-based tag search across collections belongs here.
• registry_cards.mdx: enumerate or link to valid type_name values; replace the "Deserialize the model" bullet on line 24 with a clearer noun phrase (needs SME input).
• search_registry.mdx: the "similar, but not identical, to MongoDB queries" callout doesn't specify where syntax differs; the permissions note doesn't link to a permissions explainer; add a sentence describing what registries()/.collections()/.versions() calls return.

Other observations

• search_registry.mdx: normalize the two self-page link forms (./search_registry#… vs. /models/registry/search_registry#…); verify <Frame>/<Info>/<Note> MDX components render as intended.
• download_use_artifact.mdx: Python keyword arguments in code samples use spaces around = (e.g., entity = '<team_name>'), deviating from PEP 8 — left untouched per Pass 8 scope.

How to review

• Each file's changes are style edits only. Compare side-by-side and flag any that change technical meaning.
• Approve and merge to accept the edits, or close to reject them.

[mintlify]

Preview deployment for your docs. Learn more about Mintlify Previews.

Project	Status	Preview	Updated (UTC)
wandb	🟢 Ready	View Preview	Jun 4, 2026, 2:50 PM

[github-actions]

📚 Mintlify Preview Links

🔗 View Full Preview

📝 Changed (11 total)

📄 Pages (11)

File	Preview
models/registry/aliases.mdx	Aliases
models/registry/configure_registry.mdx	Configure Registry
models/registry/create_collection.mdx	Create Collection
models/registry/create_registry.mdx	Create Registry
models/registry/delete_registry.mdx	Delete Registry
models/registry/download_use_artifact.mdx	Download Use Artifact
models/registry/lineage.mdx	Lineage
models/registry/link_version.mdx	Link Version
models/registry/organize-with-tags.mdx	Organize With Tags
models/registry/registry_cards.mdx	Registry Cards
... and 1 more files

---

🤖 Generated automatically when Mintlify deployment succeeds
📍 Deployment: 67aed69 at 2026-06-15 17:21:48 UTC

[github-actions]

🔗 Link Checker Results

✅ All links are valid!

No broken links were detected.

Checked against: https://wb-21fd5541-style-guide-models-reports-20260604-104120.mintlify.app

[ngrayluna]

Update PR title. This PR touches Reports, not Registry.

[johndmulhausen]

@ngrayluna good catch — rather than rename, I force-pushed this branch to the intended registry content. The head ref still reads …models-reports-104120, but the diff is now the 11 models/registry/*.mdx files and matches the PR title.

The reports content that was previously here is unaffected and already covered by #2723.

the diff has been replaced from under you — please re-review against the registry pages.

[Copilot]

Pull request overview

This PR applies automated style-guide edits to the W&B Registry documentation under models/registry, primarily improving wording, structure, and frontmatter metadata (for example, adding keywords) across multiple pages.

Changes:

• Adds/normalizes frontmatter keywords and updates introductory copy for clarity and consistency.
• Refines procedural steps, headings, and UI/SDK descriptions across registry docs.
• Updates/normalizes links and reference wording (with some link-target regressions that need correction).

Reviewed changes

Copilot reviewed 11 out of 11 changed files in this pull request and generated 8 comments.

Show a summary per file

File	Description
models/registry/aliases.mdx	Rewrites intro and alias guidance; updates SDK instructions and examples.
models/registry/configure_registry.mdx	Reworks access/roles content and improves descriptions and tables.
models/registry/create_collection.mdx	Clarifies collection concepts and improves SDK/UI instructions and examples.
models/registry/create_registry.mdx	Updates registry creation instructions and visibility explanation.
models/registry/delete_registry.mdx	Expands intro and clarifies deletion steps/roles.
models/registry/download_use_artifact.mdx	Clarifies how to construct and use registry artifact paths and where to get UI snippets.
models/registry/lineage.mdx	Improves lineage/audit explanations and step clarity.
models/registry/link_version.mdx	Refines linking workflow narrative and step wording for UI/SDK paths.
models/registry/organize-with-tags.mdx	Expands tag vs alias guidance and refines UI/SDK instructions text.
models/registry/registry_cards.mdx	Improves guidance on annotating collections and SDK usage wording.
models/registry/search_registry.mdx	Improves query/search explanation and example framing; adds keywords.

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[johndmulhausen]

Thanks for the review! I've pushed f1f7b2c addressing all 8 Copilot comments. Summary:

Broken anchors / links

• create_registry.mdx: #registry-visibility-types → same-page #visibility-types; #create-a-custom-registry → #create-a-registry.
• aliases.mdx: two #registry-roles links → #role-permissions; fixed the link_artifact() reference (run.md/#link_artifact → run/#method-runlink_artifact).

Correctness

• create_collection.mdx: print(...) was given a generator expression; now wrapped in a list comprehension so it prints the type names.
• aliases.mdx: corrected the parameter name alias → aliases to match the code sample and SDK.
• registry_cards.mdx: corrected the collection full-name prefix wording (wandb-registry → wandb-registry-) to match the format example.

Backward compatibility (one judgment call)

• configure_registry.mdx never actually had a #registry-roles heading — the sections are "Configure registry roles" and "Details about registry roles" — so inbound #registry-roles links were already broken on main. Rather than expand this PR's scope into models/automations/, I added an explicit <a id="registry-roles"></a> anchor above the Role permissions table. That keeps existing inbound links (e.g. create-automations.mdx) and the localized pages resolving, while the in-repo links now use the precise #role-permissions target.

Note: localized create_registry.mdx pages (ja/ko/fr) still carry the two old broken anchors until they regenerate from the English source.

@ngrayluna ready for re-review against the registry pages whenever you have a moment.