style: apply /style-guide pass to snippets/_includes#2729
Closed
johndmulhausen wants to merge 1 commit into
Closed
style: apply /style-guide pass to snippets/_includes#2729johndmulhausen wants to merge 1 commit into
johndmulhausen wants to merge 1 commit into
Conversation
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
Contributor
📚 Mintlify Preview Links📝 Changed (37 total)📄 Pages (36)
⚙️ 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-20260604-144956.mintlify.app |
Contributor
Author
|
need to rerun this after #2727 |
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
1 participant
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 37 files undersnippets/_includes. The run was automated; all 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/byob-context-note.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/private-preview-feature.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-hardware-requirements.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-delete.mdxsnippets/_includes/service-account-benefits.mdxsnippets/_includes/team-service-account-create.mdxsnippets/_includes/weave-quickstart-prereqs.mdxRecommendations for technical review
Product naming and UI labels
llm-eval-jobs/preview.mdx).api-key-create.mdx,api-key-create-streamlined.mdx,org-service-account-create.mdx,service-account-api-key-create-additional-single-tenant.mdx,service-account-api-key-delete.mdx,team-service-account-create.mdx.pin-runs-condensed.mdx.pin-runs-condensed.mdx:fa-eyefor hide andfa-eye-closed(oreye-slash) for show — the open-eye-for-hide pairing is unusual andeye-closedmay not be a standard FontAwesome 6 class.HTTP 429: rate limit exceededmatches actual output (rate-limits-defaults-and-notification.mdx).self-managed-hardware-requirements.mdx).object-storage-configuration-intro.mdx).weave-quickstart-prereqs.mdx.Deployment scope and gating
multi-tenant-cloud-only.mdx: confirm the multi-tenant-only restriction is permanent (the timeless-tense rewrite removed "Currently").enterprise-cloud-only.mdx(referenced by reviewers): the filename implies Enterprise-only but the body says "Pro or Enterprise"; rename or narrow the body.api-key-create.mdx: the hardcodedhttps://wandb.ai/settingsURL is SaaS-only — confirm it isn't included on Dedicated Cloud or self-managed pages.org-service-account-create.mdx: verify the deployment-type navigation paths (Dedicated/Self-Managed vs. Multi-tenant) are still current.Links and anchors
/platform/hosting/iam/sso#system-console,/platform/hosting/self-managed/operator#object-storage-bucket,/platform/hosting/self-managed/ref-arch/#sizing,/platform/hosting/self-managed/ref-arch/#mysql,/platform/hosting/self-managed/operator/#mysql-database,/models/launch#pricing,/release-notes/server-releases,/release-notes/server-releases-archived,/models/ref/python, andhttps://wandb.ai/site/pricing/(byob-provisioning-link.mdx,self-managed-mysql-requirements.mdx,self-managed-hardware-requirements.mdx,llm-eval-jobs/preview.mdx,release-notes-support-eol-reminder.mdx,public-api-use.mdx,enterprise-cloud-only.mdx).llm-eval-jobs/rerun-evaluation.mdx: heading change from "Re-run" to "Rerun" alters the auto-generated anchor — verify no external/internal links rely on#re-run-an-evaluation-job.llm-eval-jobs/rerun-evaluation.mdx,llm-eval-jobs/review-evaluation-results.mdx: confirm every parent page that embeds these snippets contains the in-page anchors referenced (#evaluate-your-model, etc.).private-preview-feature.mdx: snippet has no current callers — confirm whether it should be wired into the existing ad-hoc private-preview wording onrelease-notes/server-releases-archived.mdxandmodels/app/features/panels/line-plot.mdx, and whether to wrap in<Note>for consistency with sibling snippets.Terminology, acronyms, and contact info
api-key-security.mdx,private-preview-feature.mdx,self-managed-mysql-requirements.mdx.support@wandb.comvs.support@wandb.ai— acrossprivate-preview-feature.mdx,api-key-security.mdx,self-managed-mysql-requirements.mdx.byob-context-note.mdxorobject-storage-configuration-intro.mdx, or expand it in the snippet itself.public-api-use.mdx.Procedure and content gaps
api-key-create-streamlined.mdx,api-key-create.mdx,service-account-api-key-create-additional-single-tenant.mdx,team-service-account-create.mdx: confirm the "save now, can't retrieve later" one-time-view behavior and consider promoting to a<Warning>(or reusingapi-key-view-once-warning.mdx).service-account-api-key-delete.mdx: consider whether a confirmation-dialog step and an irreversibility warning belong on the snippet or its host page.self-managed-obtain-license.mdx: steps 2 and 3 are mutually exclusive branches; consider restructuring into "Choose one of the following" and merging step 4 into step 3.llm-eval-jobs/review-evaluation-results.mdx: export steps 5–6 are mutually exclusive (browser vs. programmatic) — consider splitting into subsections; also clarify direction-ambiguous "toggle Feedback or Costs", define jargon ("trace roots", "All ops", "header depth"), and verify cURL casing.self-managed-verify-installation.mdx: verify the[YOUR-DNS-DOMAIN]placeholder semantics, confirm "CORs" in the sample CLI output is current behavior or a typo, confirm "contact W&B Support" is still the correct escalation path, and propagate any edits to thefr,ko, andjalocalized siblings still using the old placeholder.self-managed-networking-requirements.mdx: clarify "each system that tracks the needs of experiments"; confirm the egress hostname list (deploy.wandb.ai,charts.wandb.ai,quay.io,gcr.io) is complete and that protocol/port requirements (HTTPS/443?) and proxy/MITM TLS-inspection guidance belong here.self-managed-object-storage-requirements.mdx: pickpre-signedvspresignedand apply consistently; consider whether encryption-at-rest/KMS belongs alongside the pre-signed URL and CORS requirements.self-managed-ssl-tls-requirements.mdx: confirm the original "self-signed certificates and custom CAs" intent (the rewrite uses "or"); confirm "certificate authorities (CAs)" is the intended expansion.rate-limits-defaults-and-notification.mdx: soften the absolute "never cause logging to crash or fail" if any edge cases exist; add remediation guidance for run-creation blocks; define or link "Filestream"; resolve the duplicate "Filestream requests per second" row labels and the inline-vs.-block duplication of the 429 log line.self-managed-version-requirements.mdx: the MySQL row has redundant/ambiguous floor ("v8.0.x is required, v8.0.32 or newer") and a misplaced comma in the Aurora MySQL phrasing — confirm intended floor before rewording.self-managed-mysql-requirements.mdx: scope-qualifier "W&B requires an external MySQL database" doesn't name the deployment mode; verify the managed-service list and consider surfacing version requirements.pin-runs-condensed.mdx: confirm pin limits (six total / five with baseline), confirm "baseline run" is defined on consuming pages, and decide whether the hide/show paragraph belongs in a separate snippet.release-notes-support-eol-reminder.mdx: confirm the 12-month support window is still current policy.api-key-find.mdx: confirm "key ID (the first part of the key)" matches the UI's terminology and that the visible location ("Your settings") is accurate.api-key-security.mdx: confirm pinned-vs-minimum version semantics forwandb==0.22.3/weave==0.52.17, the inline-envexportexample, and whetherwandb login/netrc storage should be mentioned alongside the recommended local options.Code-sample concerns (out of style scope)
Across
snippets/_includes/code-examples/*.mdx, technical owners may want to address: PEP-8 kwarg spacing (name = X→name=X), placeholder convention consistency (<…>vs. quoted strings), in-code typos (artfiact,delete_aliaes,Ceates,behaviour, "an description",log_custom_summaty_metric.mdxfilename), theartifact.tags = […]replace-vs-append behavior, thegpt-3.5-turbo-1106outdated model id inweave-quickstart-prereqs.mdx, the"What is the capitol of Paris?"nonsensical example, mismatched placeholder vs. literal metric names inlog_custom_summary_metric.mdx, single vs. triple double-quote docstrings, and whether@weave.opor@weave.op()is canonical. These are flagged for code review, not style review.How to review