Skip to content

docs(pricing-may-2026): polish pass on umbrella PR #119#126

Merged
hongyi-chen merged 3 commits into
hyc/plan-updatesfrom
hyc/plan-updates-polish
May 22, 2026
Merged

docs(pricing-may-2026): polish pass on umbrella PR #119#126
hongyi-chen merged 3 commits into
hyc/plan-updatesfrom
hyc/plan-updates-polish

Conversation

@hongyi-chen
Copy link
Copy Markdown
Collaborator

Summary

Polish pass on the May 21, 2026 pricing+packaging umbrella before #119 ships. 18 files, +129/-164.

What's in here

Pass 1 — Terminology and capitalization

  • 'Reload credits' → 'add-on credits' across the umbrella. Single canonical name (matches page title + style guide). Drop the now-redundant 'also known as' callouts.
  • 'add-on credits' is common-noun cased: lowercase mid-sentence, 'Add-on credits' at sentence/heading/bullet start. Page H1 + frontmatter title updated.
  • 'custom inference endpoint' is descriptive, not a proper noun: sentence case in headings, lowercase mid-sentence/link text.
  • BYOK consistency: 'Bring Your Own API Key (BYOK)' Title Case for first reference per page, BYOK acronym thereafter.
  • 'Auto reload' → 'auto-reload' (hyphenated, lowercase mid-sentence).

Pass 2 — Structural and rendering fixes

  • Restore 8-tab indentation on the Settings file sidebar group in src/sidebar.ts (merge artifact).
  • Fix broken permissions tables in both enterprise/team-management/teams.mdx and knowledge-and-collaboration/teams.mdx (leading || was creating a phantom empty column).
  • Fix duplicate 'A user leaves a team' bullet in both teams files (second instance was meant to be 'An admin removes a member').
  • Remove three leftover {/* TODO: Add screenshot */} MDX comments from enterprise teams.mdx.
  • pressing ENTERpressing Enter per style-guide key-name capitalization.
  • Strip GitBook   and \\~ artifacts from umbrella-touched files.
  • plans-and-billing/index.mdx 'Inference & providers' pointer now targets /agent-platform/inference/model-choice/ (section landing) instead of the BYOK page.

Pass 3 — Content polish

  • CIE caution callout: 'Oz Cloud Agents' → 'Cloud Agents' (terminology rule).
  • BYOK heading capitalization fix.
  • CIE 'Other AI features' section: replace vague one-liner with a link to BYOK's feature table (single source of truth).
  • BYOK 'If your key:' bullet list: move the 'You can update or replace your keys' bullet out of the conditional list.

Pass 4 — Cross-page consistency

  • Cloud-agent-runs-on-team-plans waterfall mechanics now live canonically in pricing-faqs.mdx; credits.mdx and add-on-credits.mdx summarize and link instead of duplicating.
  • BYOLLM scope language uniform: 'AWS Bedrock today (with Azure Foundry and Google Vertex coming soon)' across credits, platform-credits, BYOK, CIE, and enterprise billing pages.

Validation

  • npm run build passes (334 pages, no errors).
  • Zero stale /support-and-community/plans-and-billing/(bring-your-own-api-key|custom-inference-endpoint) or /agent-platform/capabilities/model-choice references in src/content/docs/.
  • Zero leftover 'Reload credits' instances in src/content/docs/.

Conversation link

Co-Authored-By: Oz oz-agent@warp.dev

…rella

Polish sweep across the May 21 pricing+packaging changes before #119 ships:

Pass 1 — Terminology and capitalization
* Standardize on 'add-on credits' (sentence case, common noun) across the
  umbrella. Mid-sentence is lowercase 'add-on credits'; sentence/heading/
  bullet-start is 'Add-on credits'. Page H1 + frontmatter title updated.
* Drop the now-redundant 'Reload credits = Add-on credits' callout from
  add-on-credits.mdx and the inline '(also known as add-on credits)'
  parentheticals.
* Treat 'custom inference endpoint' as a descriptive noun, not a proper
  noun: sentence case in headings, lowercase mid-sentence/link text.
* BYOK: Title Case as the feature name first reference per page,
  BYOK acronym thereafter. Fix 'bring your own API key (BYOK)' →
  'Bring Your Own API Key (BYOK)'.
* Standardize 'Auto reload' → 'auto-reload' (hyphenated, lowercase mid-
  sentence).

Pass 2 — Structural and rendering fixes
* Restore the 8-tab indentation regression on the Settings file sidebar
  group in src/sidebar.ts.
* Fix the broken permissions table in enterprise/team-management/teams.mdx
  (extra leading | on rows caused phantom empty column).
* Fix the same broken table in knowledge-and-collaboration/teams.mdx.
* Remove three '{/* TODO: Add screenshot */}' MDX comments from enterprise
  teams.mdx left over from drafting.
* knowledge-and-collaboration/teams.mdx: 'pressing ENTER' → 'pressing Enter'
  per style-guide key-name capitalization, drop trailing ' ' GitBook
  artifact, fix duplicate 'A user leaves a team' bullet (second one should
  have been 'An admin removes a member').
* Same duplicate-bullet fix in enterprise/team-management/teams.mdx.
* plans-and-billing/index.mdx: 'Inference & providers' pointer now targets
  /agent-platform/inference/model-choice/ (the section landing) instead of
  the BYOK page.

Pass 3 — Content polish
* custom-inference-endpoint.mdx: 'Oz Cloud Agents' → 'Cloud Agents' (per the
  'no Oz prefix on agents' terminology rule; BYOK already used 'Cloud Agents').
* bring-your-own-api-key.mdx: heading 'How BYOK differs from Custom
  inference endpoint and BYOLLM' → 'How BYOK differs from custom inference
  endpoints and BYOLLM' (sentence case).
* custom-inference-endpoint.mdx 'Other AI features' section: replace vague
  one-liner with a link to BYOK's feature table (single source of truth).
* bring-your-own-api-key.mdx: move 'You can update or replace your keys
  anytime' out of the conditional 'If your key:' list and into its own
  paragraph.

Pass 4 — Cross-page consistency
* Cloud-agent-runs-on-team-plans waterfall: pricing-faqs.mdx is the canonical
  source. credits.mdx and add-on-credits.mdx now summarize and link there
  instead of duplicating the mechanics.
* BYOLLM scope language: every BYOLLM mention now reads 'AWS Bedrock today
  (with Azure Foundry and Google Vertex coming soon)' rather than 'AWS
  Bedrock or Google Vertex' (which implied Vertex is GA).

Validated: npm run build passes (334 pages, no errors); zero stale
/support-and-community/plans-and-billing/(bring-your-own-api-key|
custom-inference-endpoint) or /agent-platform/capabilities/model-choice
URLs remain in src/content/docs/.

Co-Authored-By: Oz <oz-agent@warp.dev>
@vercel
Copy link
Copy Markdown

vercel Bot commented May 21, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
docs Ready Ready Preview, Comment May 22, 2026 12:04am

Request Review

@cla-bot cla-bot Bot added the cla-signed label May 21, 2026
@oz-for-oss
Copy link
Copy Markdown
Contributor

oz-for-oss Bot commented May 21, 2026

@hongyi-chen

I'm starting a first review of this pull request.

You can view the conversation on Warp.

I completed the review and no human review was requested for this pull request.

Comment /oz-review on this pull request to retrigger a review (up to 3 times on the same pull request).

Powered by Oz

Copy link
Copy Markdown
Contributor

@oz-for-oss oz-for-oss Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Overview

This PR polishes the May 2026 pricing and packaging documentation, primarily standardizing add-on credits terminology, BYOK/custom inference endpoint casing, and several table/sidebar rendering issues. I did not find any security findings, and the provided spec context has no approved requirements to compare against.

Concerns

  • The insufficient_credits example response still contains duplicate JSON keys after this polish pass touches the same response block, which can confuse API users copying or comparing the documented payload.

Verdict

Found: 0 critical, 1 important, 0 suggestions

Request changes

Comment /oz-review on this pull request to retrigger a review (up to 3 times on the same pull request).

Powered by Oz

{
"type": "/reference/api-and-sdk/troubleshooting/errors/insufficient-credits/",
"title": "Your team has run out of Add-on Credits. Purchase more credits in your team's billing settings to continue.",
"title": "Your team has run out of add-on credits. Purchase more credits in your team's billing settings to continue.",
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ [IMPORTANT] This example still repeats title, status, and instance later in the same JSON object; remove the duplicate fields so the response is valid and matches the other error examples.

Keep 'AWS Bedrock today, with Azure Foundry and Google Vertex coming soon'
only where it's the canonical BYOLLM explanation:
* Comparison tables on the BYOK and CIE pages.
* The dedicated 'Does Warp support other model routers or BYOLLM?' FAQ
  in pricing-faqs.mdx.
* The May 21 'What is the new custom inference endpoint feature?' FAQ
  comparison block that explains each of the three options.

Drop the scope parenthetical from passing mentions on:
* platform-credits.mdx (4 sites)
* credits.mdx (2 sites)
* pricing-faqs.mdx Enterprise plan description and 'How do platform credits
  factor in?' answer (2 sites)

Co-Authored-By: Oz <oz-agent@warp.dev>
@hongyi-chen hongyi-chen merged commit de36d5a into hyc/plan-updates May 22, 2026
3 of 4 checks passed
@hongyi-chen hongyi-chen deleted the hyc/plan-updates-polish branch May 22, 2026 00:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant