docs: refer to the web app as "W&B" instead of "W&B App"#2737
Open
johndmulhausen wants to merge 1 commit into
Open
docs: refer to the web app as "W&B" instead of "W&B App"#2737johndmulhausen wants to merge 1 commit into
johndmulhausen wants to merge 1 commit into
Conversation
Sweep the docs to stop calling the web application "the W&B App" and use the umbrella term "W&B" instead. There is no "W&B App" product in the naming guidance (AGENTS.md), so the platform is just "W&B". Scope and rules: - 85 English files, 251 replacements. Excludes translations (ja/fr/ko) and models/integrations/ (handled separately in the integrations PR #2673 to avoid overlapping changes). - "W&B App UI" -> "W&B" (the UI is the app; "UI" was redundant). - Real following nouns kept, "App" dropped: "W&B App URL/workspace/ dashboard/navigation/tab/system" -> "W&B URL/workspace/...". - "the W&B App" (noun head) -> "W&B"; dangling articles before linked "[W&B App](...)" cleaned up. Notes for review: - A few <Tab> labels now read "W&B" next to siblings like "W&B CLI" or "Environment variable". If you'd prefer "W&B UI" to keep the UI/CLI/SDK distinction in those tab groups, I can switch those. - One heading lost "App" (models/registry/link_version.mdx); no inbound links pointed at the old anchor. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Contributor
Knowledgebase navigation update
Generator warnings
|
Contributor
There was a problem hiding this comment.
Pull request overview
Repo-wide terminology sweep aligning documentation with naming guidance by replacing references to “the W&B App” with the umbrella product name “W&B”, including minor surrounding grammar/link-text adjustments.
Changes:
- Replaced “W&B App” / “W&B App UI” phrasing with “W&B” across docs (excluding translations and
models/integrations/per PR description). - Updated related link text, headings, and tab labels where the old term appeared.
- Adjusted nearby sentences to keep grammar readable after the replacement.
Reviewed changes
Copilot reviewed 85 out of 85 changed files in this pull request and generated 6 comments.
Show a summary per file
| File | Description |
|---|---|
| support/models/tags/runs.mdx | Support tag cards terminology update. |
| support/models/articles/how-do-i-rerun-a-grid-search.mdx | Support article terminology update in instructions/link text. |
| support/models/articles/how-can-i-recover-deleted-runs.mdx | Support article frontmatter + body terminology update. |
| support/models/articles/how-can-i-change-the-privacy-of-my-proje.mdx | Support article step text terminology update. |
| snippets/_includes/project-visibility-settings.mdx | Shared snippet terminology update for project visibility steps. |
| release-notes/server-releases.mdx | Release notes terminology updates in bullet text and links. |
| release-notes/server-releases-archived.mdx | Archived release notes terminology updates. |
| platform/launch/sweeps-on-launch.mdx | Launch sweeps guide terminology updates in UI instructions. |
| platform/launch/setup-vertex.mdx | Vertex setup guide terminology update in queue creation step. |
| platform/launch/setup-launch-sagemaker.mdx | SageMaker setup guide terminology update in queue creation step. |
| platform/launch/setup-launch-kubernetes.mdx | Kubernetes setup guide terminology update in queue creation step. |
| platform/launch/launch-view-jobs.mdx | Launch job viewing guide terminology updates in frontmatter and steps. |
| platform/launch/launch-terminology.mdx | Launch glossary terminology updates. |
| platform/launch/launch-faq/dockerfile_let_wb_build_docker_image_me.mdx | Launch FAQ terminology updates incl. tab labels and codeblock title. |
| platform/launch/add-job-to-queue.mdx | Add-job guide terminology updates incl. tab label. |
| platform/hosting/server-upgrade-process.mdx | Hosting upgrade process terminology updates for admin UI instructions. |
| platform/hosting/self-managed/disable-automatic-app-version-updates.mdx | Self-managed ops doc terminology update for admin steps. |
| platform/hosting/monitoring-usage/org_dashboard.mdx | Monitoring/usage doc terminology updates in definitions and steps. |
| platform/hosting/managing-bucket-storage.mdx | Storage management doc terminology updates in UI references and links. |
| platform/hosting/iam/sso.mdx | SSO doc terminology updates incl. image alt text. |
| platform/hosting/iam/scim.mdx | SCIM doc terminology updates across overview/notes. |
| platform/hosting/iam/ldap.mdx | LDAP doc terminology updates incl. tabs and steps. |
| platform/hosting/iam/identity_federation.mdx | Identity federation doc terminology update in UI description. |
| platform/hosting/iam/access-management/manage-organization.mdx | Org management doc terminology update in table row. |
| platform/hosting/enterprise-licenses.mdx | Enterprise licenses doc terminology updates incl. tabs and steps. |
| platform/hosting/data-security/secure-storage-connector.mdx | Secure storage connector doc terminology updates in procedures. |
| models/track/project-page.mdx | Project page guide terminology updates incl. tabs/steps. |
| models/track/log/log-summary.mdx | Log summary guide terminology updates in step lists. |
| models/track/log/log-models.mdx | Log models guide terminology update in UI reference sentence. |
| models/track/log/distributed-training.mdx | Distributed training guide terminology updates in UI references. |
| models/track/log/customize-logging-axes.mdx | Customize axes guide terminology update in figure description. |
| models/track/create-an-experiment.mdx | Create experiment guide terminology updates for notes/tags UI references. |
| models/track/config.mdx | Config guide terminology updates in explanation + link text. |
| models/tables/visualize-tables.mdx | Tables visualization guide terminology updates. |
| models/tables/tables-walkthrough.mdx | Tables walkthrough terminology update in steps. |
| models/tables/log_tables.mdx | Tables logging guide terminology updates in descriptions and notes. |
| models/sweeps/walkthrough.mdx | Sweeps walkthrough terminology update in visualization section. |
| models/sweeps/visualize-sweep-results.mdx | Sweeps visualization page terminology updates in frontmatter + intro. |
| models/sweeps/sweep-config-keys.mdx | Sweep config keys page terminology updates in references/links. |
| models/sweeps/existing-project.mdx | Existing-project sweeps tutorial terminology updates. |
| models/runs/view-logged-runs.mdx | Runs viewing page terminology updates in frontmatter + copy. |
| models/runs/tags.mdx | Runs tags page terminology update in frontmatter + instructions. |
| models/runs/stop-runs.mdx | Stop runs page terminology updates incl. tabs and description. |
| models/runs/run-states.mdx | Run states page terminology updates incl. tabs and intro. |
| models/runs/run-identifiers.mdx | Run identifiers page terminology updates incl. tabs/codeblock title. |
| models/runs/rewind.mdx | Rewind page terminology update in archived run section. |
| models/runs/manage-runs.mdx | Manage runs page terminology update in description. |
| models/runs/grouping.mdx | Grouping page terminology updates incl. tab label and prose. |
| models/runs/forking.mdx | Forking page terminology update in intro to section. |
| models/runs/delete-runs.mdx | Delete runs page terminology updates incl. tabs and note. |
| models/runs/compare-runs.mdx | Compare runs page terminology update in intro. |
| models/runs.mdx | Runs landing page terminology updates incl. note and description. |
| models/reports/edit-a-report.mdx | Reports editing guide terminology updates incl. tab labels. |
| models/reports/create-a-report.mdx | Reports creation guide terminology updates incl. frontmatter/tabs. |
| models/reports/clone-and-export-reports.mdx | Reports clone/export guide terminology updates incl. tabs. |
| models/reports.mdx | Reports landing page terminology update in getting started steps. |
| models/registry/search_registry.mdx | Registry search doc terminology update in instruction line. |
| models/registry/organize-with-tags.mdx | Registry tags doc terminology updates incl. frontmatter + tabs. |
| models/registry/link_version.mdx | Registry link-version doc terminology updates incl. headings/steps. |
| models/registry/download_use_artifact.mdx | Registry download/use artifact doc terminology update in UI reference. |
| models/registry/delete_registry.mdx | Registry delete doc terminology updates incl. tab label/frontmatter. |
| models/registry/create_collection.mdx | Registry create collection doc terminology updates incl. tabs. |
| models/registry.mdx | Registry landing page terminology update in enablement table. |
| models/ref/wandb_workspaces/workspaces.mdx | Workspaces reference terminology update in class description. |
| models/ref/python/experiments/system-metrics.mdx | System metrics reference terminology updates in tabs/steps. |
| models/ref/python/experiments/run.mdx | Run reference terminology update in jobType description. |
| models/ref/python/experiments/artifact.mdx | Artifact reference terminology updates in arg docs and method docs. |
| models/ref/cli/wandb-sweep.mdx | CLI reference terminology update for where to find sweep ID. |
| models/ref/cli/wandb-agent.mdx | CLI reference terminology update for where to find sweep ID. |
| models/models_quickstart.mdx | Quickstart terminology update in cross-link sentence. |
| models/automations/registry-automation-tutorial.mdx | Automations tutorial terminology update in comments and prose. |
| models/automations/project-automation-tutorial.mdx | Automations tutorial terminology update in comments. |
| models/automations/create-automations/webhook.mdx | Webhook automation doc terminology updates incl. tab label and steps. |
| models/automations/create-automations.mdx | Automations create page terminology update in link description. |
| models/automations/api.mdx | Automations API page terminology updates in frontmatter + note + links. |
| models/automations.mdx | Automations landing page terminology update in next-steps bullet. |
| models/artifacts/ttl.mdx | Artifacts TTL doc terminology updates incl. tabs and notes. |
| models/artifacts/track-external-files.mdx | Track external files doc terminology updates in UI references. |
| models/artifacts/explore-and-traverse-an-artifact-graph.mdx | Artifact lineage doc terminology updates incl. tabs and steps. |
| models/artifacts/delete-artifacts.mdx | Delete artifacts doc terminology updates incl. diagram labels and tabs. |
| models/artifacts/construct-an-artifact.mdx | Construct artifact doc terminology update in note. |
| models/app/keyboard-shortcuts.mdx | Keyboard shortcuts doc terminology updates in intro and notes. |
| models/app/features/panels/line-plot/sampling.mdx | Line plot sampling doc terminology update in bullet text. |
| models/app/features/cascade-settings.mdx | Cascade settings page terminology update in description. |
| models/app/console-logs.mdx | Console logs doc terminology updates incl. steps and inline comments. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| View information about a specific run, such as its current state, artifacts, metrics, and more. You can view and monitor runs using W&B or the `wandb beta leet` terminal UI. | ||
|
|
||
| <Tabs> | ||
| <Tab title="WA&B App"> |
| 3. Run a run manually `python train.py` | ||
|
|
||
| Optionally explore the example appear in the W&B App UI dashboard. | ||
| Optionally explore the example appear in W&B dashboard. |
| ## Visualize results (optional) | ||
|
|
||
| Open your project to see your live results in the W&B App dashboard. With just a few clicks, construct rich, interactive charts like [parallel coordinates plots](/models/app/features/panels/parallel-coordinates/),[ parameter importance analyzes](/models/app/features/panels/parameter-importance/), and [additional chart types](/models/app/features/panels/). | ||
| Open your project to see your live results in the W&B dashboard. With just a few clicks, construct rich, interactive charts like [parallel coordinates plots](/models/app/features/panels/parallel-coordinates/),[ parameter importance analyzes](/models/app/features/panels/parameter-importance/), and [additional chart types](/models/app/features/panels/). |
| Create a sweep interactively with W&B. | ||
|
|
||
| 1. Navigate to your W&B project on the W&B App. | ||
| 1. Navigate to your W&B project on W&B. |
| </Note> | ||
|
|
||
| 1. Identify the sweep name/ID for a previously run launch sweep. The sweep ID is an eight-character string (for example, `hhd16935`) that you can find in your project on the W&B App. | ||
| 1. Identify the sweep name/ID for a previously run launch sweep. The sweep ID is an eight-character string (for example, `hhd16935`) that you can find in your project on W&B. |
|
|
||
| ## Next steps | ||
| - [Automations tutorial](/models/automations/tutorial): Guides you to create a project automation to alert on run failures and a Registry automation to run a webhoook when an alias is added. The tutorial uses the W&B App. | ||
| - [Automations tutorial](/models/automations/tutorial): Guides you to create a project automation to alert on run failures and a Registry automation to run a webhoook when an alias is added. The tutorial uses W&B. |
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
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
Repo-wide terminology sweep: stop referring to the web application as "the W&B App" and use the umbrella term "W&B" instead. There is no "W&B App" product in the naming guidance (
AGENTS.mdsays the platform is "W&B"), so this aligns the docs with that convention.This was requested as a follow-up to review feedback on #2673 (where a reviewer flagged that "the W&B App" should no longer be used).
Scope
ja/,fr/,ko/) andmodels/integrations/— the integration files are actively changing in style: apply /style-guide pass to models/integrations #2673, so they're handled there to avoid overlapping edits between the two PRs.Replacement rules
W&B App UI→W&B(the UI is the app; "UI" was redundant).W&B App URL/workspace/dashboard/navigation/tab/system→W&B URL/workspace/....the W&B App(as a noun) →W&B(article dropped so grammar stays clean, for example "in the W&B App" → "in W&B").[W&B App](...)cleaned up (for example "Navigate to the W&B App" → "Navigate to W&B").Notes for review
<Tab>labels now read "W&B" next to siblings like "W&B CLI" or "Environment variable" (for example inplatform/launch/add-job-to-queue.mdx,platform/hosting/iam/ldap.mdx). If you'd prefer "W&B UI" in those tab groups to keep the UI/CLI/SDK distinction, I can switch just those.models/registry/link_version.mdx). I verified no inbound links pointed at the old anchor.How to review
Every change is
"W&B App"→"W&B"(with grammar cleanup). No technical content changed.🤖 Generated with Claude Code