style: apply /style-guide pass to snippets/_includes#2736
Open
johndmulhausen wants to merge 4 commits into
Open
style: apply /style-guide pass to snippets/_includes#2736johndmulhausen wants to merge 4 commits into
johndmulhausen wants to merge 4 commits into
Conversation
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
Contributor
There was a problem hiding this comment.
Pull request overview
This PR applies an automated /style-guide pass (Google Developer Style Guide + CoreWeave conventions) across documentation includes under snippets/_includes, with edits intended to be style-only while preserving meaning.
Changes:
- Standardizes wording, punctuation, and sentence structure across many include snippets.
- Improves clarity in step-by-step UI instructions and short reference notes.
- Normalizes formatting of lists and code blocks in self-managed / CLI-related snippets.
Reviewed changes
Copilot reviewed 39 out of 39 changed files in this pull request and generated 5 comments.
Show a summary per file
| File | Description |
|---|---|
| snippets/_includes/api-key-create-streamlined.mdx | Rewords streamlined API key creation note for clarity. |
| snippets/_includes/api-key-create.mdx | Adjusts personal API key creation step wording/format. |
| snippets/_includes/api-key-find.mdx | Clarifies API key lookup instructions and “view once” behavior wording. |
| snippets/_includes/api-key-security.mdx | Expands secure storage guidance; updates examples and SDK compatibility notes. |
| snippets/_includes/api-key-view-once-warning.mdx | Refines “view once” warning wording. |
| snippets/_includes/automations/actions-list.mdx | Rephrases Slack/webhook action descriptions for consistency. |
| snippets/_includes/automations/best-practices.mdx | Minor wording tweaks to automation best-practice bullets. |
| snippets/_includes/automations/tutorial-go-further.mdx | Rewords intro sentence for “go further” resource links. |
| snippets/_includes/byob-provisioning-link.mdx | Tightens provisioning lead-in sentence and link intro wording. |
| snippets/_includes/cli/README.md | Rewords/structures contributor guidance for CLI intro snippets. |
| snippets/_includes/cli/wandb-beta-leet.mdx | Large set of style/clarity edits across LEET CLI documentation. |
| snippets/_includes/code-examples/runs_update_tag_public_api.mdx | Clarifies explanatory text for the Public API tags example. |
| snippets/_includes/line-plot-capture-groups.mdx | Small wording tweak in capture-group example explanation. |
| snippets/_includes/llm-eval-jobs/export-evaluation.mdx | Rephrases export instructions; adjusts step wording. |
| snippets/_includes/llm-eval-jobs/preview.mdx | Adjusts preview note wording/link text. |
| snippets/_includes/llm-eval-jobs/rerun-evaluation.mdx | Expands intro and refines re-run instructions wording. |
| snippets/_includes/llm-eval-jobs/review-evaluation-results.mdx | Refines leaderboard export instructions wording. |
| snippets/_includes/multi-tenant-cloud-only.mdx | Shortens availability note wording. |
| snippets/_includes/object-storage-configuration-intro.mdx | Adds terminal punctuation; rephrases bullets slightly. |
| snippets/_includes/org-service-account-create.mdx | Splits/clarifies navigation steps; condenses subsequent steps. |
| snippets/_includes/pinned-and-baseline-runs/pin-runs-condensed.mdx | Rewords pinning limits/behavior sentence for consistency. |
| snippets/_includes/project-visibility-settings.mdx | Refines “Open” visibility guidance and note wording. |
| snippets/_includes/public-api-use.mdx | Rephrases callout to be more direct/active voice. |
| snippets/_includes/rate-limits-defaults-and-notification.mdx | Adds an explanatory lead-in sentence and refines bullet wording. |
| snippets/_includes/release-notes-support-eol-reminder.mdx | Reorders/supports EOL reminder note wording. |
| snippets/_includes/self-managed-mysql-database-creation.mdx | Updates placeholder wording in SQL example intro and statement. |
| snippets/_includes/self-managed-mysql-requirements.mdx | Minor wording/whitespace cleanup and link sentence clarity. |
| snippets/_includes/self-managed-networking-requirements.mdx | Rewords egress guidance and note copy for readability. |
| snippets/_includes/self-managed-object-storage-requirements.mdx | Reworks provider list phrasing and surrounding guidance text. |
| snippets/_includes/self-managed-obtain-license.mdx | Clarifies trial/license acquisition steps and bullet punctuation. |
| snippets/_includes/self-managed-redis-requirements.mdx | Rephrases Redis requirements and environment list item wording. |
| snippets/_includes/self-managed-ssl-tls-requirements.mdx | Rewords TLS requirements and guidance sentences for clarity. |
| snippets/_includes/self-managed-verify-installation.mdx | Improves structure/indentation of verify instructions and code blocks. |
| snippets/_includes/service-account-api-key-create-additional-single-tenant.mdx | Small wording updates to steps (create key + naming). |
| snippets/_includes/service-account-api-key-create-additional.mdx | Rephrases first step for clarity. |
| snippets/_includes/service-account-api-key-delete.mdx | Minor sentence tightening in key deletion steps. |
| snippets/_includes/service-account-benefits.mdx | Adds consistent punctuation and contractions in benefit bullets. |
| snippets/_includes/team-service-account-create.mdx | Condenses steps and improves consistency of UI label emphasis. |
| snippets/_includes/weave-quickstart-prereqs.mdx | Adds terminal punctuation to the OpenAI key prerequisite. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Contributor
📚 Mintlify Preview Links📝 Changed (39 total)📄 Pages (38)
⚙️ Other (1)
🤖 Generated automatically when Mintlify deployment succeeds |
Contributor
🔗 Link Checker Results✅ All links are valid! No broken links were detected. Checked against: https://wb-21fd5541-style-guide-snippets-includes-20260605-162100.mintlify.app |
- api-key-security: drop `export` from the inline env-var anti-pattern (invalid shell: `export VAR=... cmd` treats `cmd` as an arg to export), and use `<your-api-key>` angle-bracket placeholder - rate-limits: fix SDK log message `rate limited exceeded` -> `rate limit exceeded` to match the example block and the actual SDK string - self-managed-networking: wrap egress endpoint URLs in backticks and drop a stray trailing period so autolinkers can't absorb punctuation - self-managed-redis: correct vendor branding to Amazon ElastiCache and Google Cloud Memorystore Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Partially reverts 6d744f5. The block is a labeled "avoid this pattern" example that readers are explicitly told not to run, and the original `export WANDB_API_KEY=... ./my-script.sh` form better conveys the intended "don't put the key inline with the command" warning. Copilot's point that `export VAR=val cmd` isn't a valid run-the-script invocation is correct but moot for a "don't do this" snippet. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Per repo-owner decision, wandb/docs adopts the CoreWeave /style-guide bracket-style uppercase placeholder convention ([ALL-CAPS-HYPHENATED]). Reverts the angle-bracket form introduced in 6d744f5. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
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
This PR applies the
/style-guideskill (Google Developer Style Guide + CoreWeave conventions) to 39 files undersnippets/_includes. The run was automated; edits are style-only and preserve technical meaning.Files edited
snippets/_includes/api-key-create-streamlined.mdxsnippets/_includes/api-key-create.mdxsnippets/_includes/api-key-find.mdxsnippets/_includes/api-key-security.mdxsnippets/_includes/api-key-view-once-warning.mdxsnippets/_includes/automations/actions-list.mdxsnippets/_includes/automations/best-practices.mdxsnippets/_includes/automations/tutorial-go-further.mdxsnippets/_includes/byob-provisioning-link.mdxsnippets/_includes/cli/README.mdsnippets/_includes/cli/wandb-beta-leet.mdxsnippets/_includes/code-examples/runs_update_tag_public_api.mdxsnippets/_includes/line-plot-capture-groups.mdxsnippets/_includes/llm-eval-jobs/export-evaluation.mdxsnippets/_includes/llm-eval-jobs/preview.mdxsnippets/_includes/llm-eval-jobs/rerun-evaluation.mdxsnippets/_includes/llm-eval-jobs/review-evaluation-results.mdxsnippets/_includes/multi-tenant-cloud-only.mdxsnippets/_includes/object-storage-configuration-intro.mdxsnippets/_includes/org-service-account-create.mdxsnippets/_includes/pinned-and-baseline-runs/pin-runs-condensed.mdxsnippets/_includes/project-visibility-settings.mdxsnippets/_includes/public-api-use.mdxsnippets/_includes/rate-limits-defaults-and-notification.mdxsnippets/_includes/release-notes-support-eol-reminder.mdxsnippets/_includes/self-managed-mysql-database-creation.mdxsnippets/_includes/self-managed-mysql-requirements.mdxsnippets/_includes/self-managed-networking-requirements.mdxsnippets/_includes/self-managed-object-storage-requirements.mdxsnippets/_includes/self-managed-obtain-license.mdxsnippets/_includes/self-managed-redis-requirements.mdxsnippets/_includes/self-managed-ssl-tls-requirements.mdxsnippets/_includes/self-managed-verify-installation.mdxsnippets/_includes/service-account-api-key-create-additional-single-tenant.mdxsnippets/_includes/service-account-api-key-create-additional.mdxsnippets/_includes/service-account-api-key-delete.mdxsnippets/_includes/service-account-benefits.mdxsnippets/_includes/team-service-account-create.mdxsnippets/_includes/weave-quickstart-prereqs.mdxRecommendations for technical review
UI labels, paths, and surfaces
automations/*/ Weave snippets.https://wandb.ai/settingsis the canonical destination for API key creation, that "User Settings" matches the current UI label, and that the snippet's hardcodedwandb.aihost is appropriate for Dedicated Cloud / W&B Server contexts (api-key-create-streamlined.mdx,api-key-create.mdx,api-key-find.mdx).>separator form (api-key-find.mdx,api-key-create.mdx).api-key-create.mdx).org-service-account-create.mdx,service-account-api-key-create-additional.mdx,service-account-api-key-create-additional-single-tenant.mdx,service-account-api-key-delete.mdx,team-service-account-create.mdx).service-account-api-key-delete.mdx, verify the actual delete affordance (named button vs. trash icon) and reconcile link text "Organization settings" with destinationhttps://wandb.ai/account-settings/.api-key-view-once-warning.mdx).automations/*).llm-eval-jobs/export-evaluation.mdx— bold the verbatim label if one exists.#evaluate-your-modelanchor inllm-eval-jobs/rerun-evaluation.mdx; verify Mintlify renders the nested1. 1. 1.Markdown auto-numbering correctly.pinned-and-baseline-runs/pin-runs-condensed.mdx(fa-regular fa-eyeto hide,fa-solid fa-eye-closedto show) — easy to swap by mistake. Also confirm pin limits (six runs total / five with a baseline)./weave/guides/core-types/leaderboardscross-reference inllm-eval-jobs/review-evaluation-results.mdx.Product/feature accuracy
/models/launch#pricingis the right destination (llm-eval-jobs/preview.mdx).automations/actions-list.mdx.object-storage-configuration-intro.mdx,byob-provisioning-link.mdx)./platform/hosting/data-security/secure-storage-connectoractually covers all five listed storage types (object-storage-configuration-intro.mdx).project-visibility-settings.mdx, including whether re-invitation behavior differs by source/target combination, and that/models/reports/collaborate-on-reports#share-a-reportresolves.rate-limits-defaults-and-notification.mdx: align the duplicate "Filestream requests per second" row labels (Project vs. Run) and the SDK error string (HTTP 429: rate limited exceededvs.rate limit exceeded).release-notes-support-eol-reminder.mdx./platform/hosting/self-managed/on-premises-deployments/kubernetes-airgappedinself-managed-networking-requirements.mdx.Self-managed requirements
self-managed-mysql-requirements.mdx).self-managed-redis-requirements.mdx).self-managed-object-storage-requirements.mdx).self-managed-networking-requirements.mdxand related).'<password>') and intentional host wildcard (wandb_local@'%') inself-managed-mysql-database-creation.mdx.self-managed-verify-installation.mdxandself-managed-mysql-requirements.mdx).self-managed-ssl-tls-requirements.mdx; consider noting Istio/sidecar caveats.self-managed-verify-installation.mdxNote links to admin-account creation, explicitly explains theYOUR_DNS_DOMAINplaceholder, and adds per-check troubleshooting or a support link.self-managed-obtain-license.mdx.Security and credentials
api-key-create-streamlined.mdx).netrc); reconsider theexport ...Warning block syntax and the "in line with the command" phrasing inapi-key-security.mdx.wandbv0.22.3+,weavev0.52.17+), expand AISE on first use, and add awandb login --relogin/ key-rotation pointer (api-key-security.mdx,release-notes-support-eol-reminder.mdx).api-key-create.mdx, and verify "key ID (the first part of each API key)" is technically accurate.ApiKeyViewOnceWarning(service-account-api-key-create-additional.mdx,service-account-api-key-create-additional-single-tenant.mdx,org-service-account-create.mdx,team-service-account-create.mdx).team-service-account-create.mdx.service-account-benefits.mdxbullet descriptions parallel and replace marketing framing ("Enterprise-ready," "Built for production automation at scale") with concrete capabilities.Content/structure
llm-eval-jobs/preview.mdx).WB-34263(Python SDKcreate_automationregression) status so the commented-out bullets inautomations/tutorial-go-further.mdxcan be restored; confirm/models/automations/automation-eventsand related anchors.'rankSpacing': 200;) renders in the docs site's Mermaid version inautomations/best-practices.mdx-adjacent diagrams; clarify ambiguous bullets ("test project or with a test webhook," severity-based routing).<TutorialDiagramProject/>and<TutorialDiagramRegistry/>render correctly when indented inside list items (automations/tutorial-go-further.mdx).cli/README.md"How it works" template is shown or linked, that the generator-run trigger is documented, and that local-preview instructions are linked.cli/wandb-beta-leet.mdx(LEET config precedence withXDG_CONFIG_HOME,per_seriespalette key, changelog repo link, pin vs. highlight semantics, live-run polling, tail-window default, Hopper scoping, "tensorcore" capitalization, media pane arrow-key behavior, 0.23.1 cell run-on, completeness of shortcut tables, bare-term filter scope).code-examples/runs_update_tag_public_api.mdx, confirm whetherrun.tagsis a tuple (matches docstring ++= ("<tag3>",)usage) and that<entity>,<project>,<tag1..3>placeholder conventions match siblings.multi-tenant-cloud-only.mdx, and that the snippet reads as a complete thought across every include site (or rewrite to a full sentence).enterprise-only.mdx-style snippets (referenced from style passes).#wb-multi-tenant-cloudon/platform/hosting/(multi-tenant-cloud-only.mdx).5_fold_cv(line-plot-capture-groups.mdx).public-api-use.mdx, confirm whether "should match" the metric-name regex should be tightened to "must match," and consider documenting maximum length / reserved-name restrictions.weave-quickstart-prereqs.mdx, verify supported version floors (Python 3.10+, Node.js 18+), canonical install commands, and whether to name theOPENAI_API_KEYenv var explicitly.How to review