Skip to content

style: apply /style-guide pass to support/inference/articles#2670

Merged
johndmulhausen merged 2 commits into
mainfrom
style-guide/support-inference-articles-20260526-224448
May 27, 2026
Merged

style: apply /style-guide pass to support/inference/articles#2670
johndmulhausen merged 2 commits into
mainfrom
style-guide/support-inference-articles-20260526-224448

Conversation

@johndmulhausen
Copy link
Copy Markdown
Contributor

Summary

This PR applies the /style-guide skill (Google Developer Style Guide + CoreWeave conventions) to the seven support articles for Serverless Inference API error codes listed below. The run was fully automated; only style-level edits were made.

Files edited

  • support/inference/articles/api-error-code-401-authentication-failed.mdx
  • support/inference/articles/api-error-code-402-you-exceeded-your-cur.mdx
  • support/inference/articles/api-error-code-403-country-region-or-ter.mdx
  • support/inference/articles/api-error-code-403-the-inference-gateway.mdx
  • support/inference/articles/api-error-code-429-concurrency-limit-rea.mdx
  • support/inference/articles/api-error-code-500-the-server-had-an-err.mdx
  • support/inference/articles/api-error-code-503-the-engine-is-current.mdx

Recommendations for technical review

Verification steps

  • 401 article: Add a step to verify a regenerated API key works (for example, a sample successful response), and describe what a resolved state looks like (such as receiving a 200 from the inference endpoint).
  • 403 (country/region): Add a brief expected-outcome statement (for example, "After moving to a supported location, retrying the request returns a 200 response") and consider documenting an escalation path for false-positive geo-blocks.
  • 403 (inference gateway): Describe what the reader should expect after an administrator enables the gateway — how quickly the 403 stops, whether the client needs to retry, and any propagation delay.
  • 429 article: Add a pointer for confirming the fix worked, such as how to observe concurrency levels or verify that 429 responses have stopped.
  • 500 article: Specify a recommended initial wait time and backoff factor (for example, "1 second, doubling up to 30 seconds") instead of generic "a few seconds" / "exponential backoff."

Missing content

  • 401 article: Tell the reader how to find the correct entity or project name (UI location, API method, or wandb CLI command), and link to the auth configuration docs for readers landing cold.
  • 402 article (api-error-code-402-you-exceeded-your-cur.mdx:19-21): Link the three "Restore access" items to W&B account settings/billing, the purchase or upgrade flow, and the spending-cap configuration location (note the required role/permission for adjusting the cap).
  • 403 (country/region): Link "Enterprise customers" and clarify "special arrangements" (enterprise contracts, dedicated deployments) or remove the phrase, and link to the account-team contact page.
  • 403 (inference gateway): Add inline links for "the inference gateway" and "Serverless Inference" to a concept page or overview.
  • 429 article: Define or link an explanation for "exponential backoff," document actual concurrency limits per plan (or how a user can find their current limit), and describe how to request a limit increase.
  • 500 article: Specify a retry threshold before contacting support (for example, "after 3–5 retries with backoff") and name the specific details support needs (such as a request ID or correlation ID, if Serverless Inference returns one).

Technical accuracy

  • 401 article: Confirm the 401 + "Authentication failed" message is exclusive to the Serverless Inference API and not raised by other W&B endpoints with different remediation.
  • 402 article: Verify the literal API error string You exceeded your current quota, please check your plan and billing details matches the exact message returned by the Inference API (now in code font, so mismatches will be more visible).
  • 403 (country/region) (lines 28-35): Confirm Serverless Inference determines your location from your IP address at the time of the API request is the sole geolocation mechanism (not billing address, account region, or proxy detection), and verify the literal error JSON matches the current API response shape (field names, types, and 403 as integer vs. string). Also confirm the anchor link /inference/usage-limits/#geographic-restrictions is still the canonical destination.
  • 403 (inference gateway): Reconcile audience framing — the keywords frontmatter tags the article for "Administrator," but the body addresses the blocked end user. Also review the casing of "the inference gateway" if it's an official product or feature name (style editor preserved existing casing).
  • 429 article: Confirm that the recommended remediation (queuing/throttling plus exponential backoff) is the correct, currently supported guidance for Serverless Inference 429 concurrency errors.
  • 500 article: Verify "Serverless Inference" is the canonical product name used elsewhere in the W&B Inference docs, or whether it should be "W&B Inference."

Information architecture

  • 403 (country/region): Consider placing "Error details" before "What you can do" so readers confirm the error signature before working through the fix.

Prerequisites

  • 401 and 403 (country/region) articles assume the reader knows where the API key is supplied (header, env var, or client config) and don't include a prerequisites section. As short error-reference articles this is likely fine, but a technical reviewer should confirm.

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.

@johndmulhausen johndmulhausen requested a review from a team as a code owner May 27, 2026 02:45
@mintlify
Copy link
Copy Markdown
Contributor

mintlify Bot commented May 27, 2026

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

Project Status Preview Updated (UTC)
wandb 🟢 Ready View Preview May 27, 2026, 2:48 AM

@github-actions
Copy link
Copy Markdown
Contributor

Knowledgebase navigation update

  • Tag pages modified: 5 pages.

From workflow run 26487607905

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 27, 2026

📚 Mintlify Preview Links

🔗 View Full Preview

📝 Changed (12 total)

📄 Pages (12)

File Preview
support/inference/articles/api-error-code-401-authentication-failed.mdx Api Error Code 401 Authentication Failed
support/inference/articles/api-error-code-402-you-exceeded-your-cur.mdx Api Error Code 402 You Exceeded Your Cur
support/inference/articles/api-error-code-403-country-region-or-ter.mdx Api Error Code 403 Country Region Or Ter
support/inference/articles/api-error-code-403-the-inference-gateway.mdx Api Error Code 403 The Inference Gateway
support/inference/articles/api-error-code-429-concurrency-limit-rea.mdx Api Error Code 429 Concurrency Limit Rea
support/inference/articles/api-error-code-500-the-server-had-an-err.mdx Api Error Code 500 The Server Had An Err
support/inference/articles/api-error-code-503-the-engine-is-current.mdx Api Error Code 503 The Engine Is Current
support/inference/tags/administrator.mdx Administrator
support/inference/tags/authentication-access.mdx Authentication Access
support/inference/tags/billing.mdx Billing
... and 2 more files

🤖 Generated automatically when Mintlify deployment succeeds
📍 Deployment: 8b7109c at 2026-05-27 02:50:39 UTC

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 27, 2026

🔗 Link Checker Results

All links are valid!

No broken links were detected.

Checked against: https://wb-21fd5541-style-guide-support-inference-articles-20260526.mintlify.app

@johndmulhausen johndmulhausen merged commit 3d15803 into main May 27, 2026
10 checks passed
@johndmulhausen johndmulhausen deleted the style-guide/support-inference-articles-20260526-224448 branch May 27, 2026 15:41
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.

2 participants