Skip to content

docs(aigw): Phase 5 — callouts, naming, page hygiene - #1078

Closed
vrv-panw wants to merge 6 commits into
docs/prisma-airs-phase-4-linksfrom
docs/prisma-airs-phase-5
Closed

vrv-panw wants to merge 6 commits into
docs/prisma-airs-phase-4-linksfrom
docs/prisma-airs-phase-5

Conversation

@vrv-panw

Copy link
Copy Markdown
Contributor

Stacks on #1077. Review that first — this diff is only the six commits listed below.

Phase 5 of the Prisma AIRS AI Gateway docs migration. All seven TODO items are done; each slice was mint validate green before the next started, and the eight renames were checked with mint broken-links (aigw broken-link count unchanged at 4, all pre-existing).

Slice Scope
cc27c7c2 Sales CTAs and support "reach out" trailers — 53 files
f808ad61 Pro/Enterprise plan-gating callouts — 24 files
5090818f Agent Gateway webinar banner — docs.json
0b5b2b58 API key renamed to Gateway API Key in prose — 13 edits, 10 files
cd88027d Setup Guide cut to its core steps, 8 filename normalisations
c153a29a 6 composite headings split into heading + prose

What was deliberately kept

  • Deployment-shape constraints (self-hosted, hybrid, air-gapped) are real requirements, not plan gates.
  • Third-party vendors' own pricing tiers — Cursor, Figma, Atlassian, Tavily, Anthropic. Not ours to rewrite.
  • Every functional identifier. The API-key rename touched prose only: of 1,384 "portkey api key" spellings under aigw/, 1,371 are the env var, the HTTP header or the config key. A before/after count over six identifier patterns proves none moved.
  • Long headings that are genuinely one titleExample: …, MCP Gateway: …, linked headings.

Three things to confirm

  1. The Setup Guide points somewhere other than what was picked. The chosen target was the Latest-version /introduction/make-your-first-request, but that page has exactly three headings — Get your Portkey API Key, Integrate Portkey, Next Steps — and covers none of the three cut steps. Pointing at it would have been a dead end, so the page points at /aigw/integrations/guardrails/palo-alto-panw-prisma and /aigw/product/ai-gateway/configs instead.
  2. The page title is now "Simple Setup", not "Setup Guide", to match the requested filename. One-line revert if the filename was meant to change but the title kept.
  3. ~30 pages now have no support escalation path. Direct consequence of taking both the sales CTAs and the support trailers.

Blast radius outside aigw/

The webinar banner was the global banner key in docs.json, not an .mdx — removing it also takes it off Latest and Virtual Keys. Agreed in advance as an explicit exception to the no-Latest-edits rule.

No redirects were added for the eight renames, per PLAN assumption 9: these are new URLs with no inbound links.

🤖 Generated with Claude Code

vrv-panw and others added 6 commits September 15, 2026 17:16
Phase 5, first item. Two classes of contact ask, both removed on your call:

Sales CTAs (13 files) — "Book a Demo" and "Schedule a Demo" cards, the
"Interested? Schedule a Call Below" iframe on enterprise-offering, the
"schedule a quick call"/"consultation" links on rate-limits, budget-limits
and enforce-budget-and-rate-limit, and two "Reach out to our team" blocks.

Support trailers (33 files) — the "If you face any issues with X, reach out
to support@portkey.ai" paragraph and its variants. Where the trailer was the
only content under a "## Get Support" or "## Support" heading, the now-empty
heading goes with it; 29 such headings were removed.

Consequence worth naming: those pages no longer state an escalation path.
support@portkey.ai survives elsewhere (it is its own RESIDUE item), but the
per-integration pointer is gone by design, not by oversight.

aigw/scripts/strip_ctas.py does the repeating shapes and reports anything it
does not recognise rather than guessing; the six it flagged were hand-edited.
It is line-based on purpose — an earlier whole-file blank-line collapse
reflowed 119 files that had no CTA in them at all.

mint validate green.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Phase 5, second item. 22 callouts across 21 files stating that a feature is
gated behind a commercial tier, usually paired with an ask to contact us.

Three distinctions drove what stayed:

Plan tier vs deployment shape. "Enterprise self-hosted plans only" is two
claims wearing one coat. The tier goes; "available on self-hosted deployments"
is a real constraint a reader needs and stays — budget-policies, metadata,
otel/complete-logs, mcp-gateway/advanced-configuration.

Plan tier vs version requirement. secret-references and budget-policies gated
on a tier *and* a minimum gateway version. Only the tier was removed.

Ours vs theirs. Cursor, Figma, Atlassian and Tavily document their own
vendors' plan tiers. Those are facts about a third party, not our pricing,
and are untouched.

Also removed the "Plan restriction" cause from the permissions troubleshooting
page: with tiers undocumented it is no longer a diagnosis a reader can act on.

Descriptive "Enterprise Features" headings and cards are not gating callouts
and were left alone.

mint validate green.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Phase 5, fourth item. The ticker was a single top-level "banner" key in
docs.json, not an aigw-scoped element, so there was no way to drop it from
Prisma AIRS alone.

Removed globally on your call. This is a deliberate exception to "nothing in
the Latest version is modified" — the banner is now gone from Latest and
Virtual Keys (Deprecated) as well, and both linked to portkey.sh campaign
URLs that outlive the webinar anyway.

mint validate green.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Phase 5, third item. 13 human-readable mentions across 10 files.

The item reads larger than it is. aigw carries 1,384 occurrences of some
"portkey api key" spelling, but 1,243 are the PORTKEY_API_KEY environment
variable, 79 the x-portkey-api-key header and 62 the portkey_api_key config
key — all functional identifiers on the never-rename list. Only 13 were prose
a reader merely reads.

Renamed: Helm values comments, three MCP auth diagrams, the OpenWebUI valve
description string and shared-key label, the OpenAI-compatible setup step, and
the LiveKit placeholder. Where a line held both, the identifier was left and
only the sentence around it changed — "PORTKEY_API_KEY=<PORTKEY_API_KEY>
# Replace <PORTKEY_API_KEY> with Gateway API Key".

Guarded by a before/after count over six identifier patterns; all six are
unchanged.

Also caught in passing: those same Helm comments said the key comes "from
Portkey website" while already pointing at the Strata Cloud Manager URL. Now
they say Strata Cloud Manager.

mint validate green.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
…ames

Phase 5 items 5 and 6.

The Setup Guide's scope had crept into plugin enablement, guardrail
creation and config creation, none of which belong in a first-request
walkthrough and all of which were wrong in the details. Cut those three
steps, renumber the rest, and point at the pages that own that content.

Rename eight pages whose filenames had drifted from their titles or
carried typos, including the requested simple-setup.mdx. Navigation and
inbound links repointed. No redirects: these are new URLs with no
inbound traffic (PLAN assumption 9).

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Six headings had a full sentence glued onto the title, so the sentence
appeared in the sidebar and the anchor link. Split each into a heading
plus the paragraph it was swallowing. No wording changed.

Long headings that are genuinely one title — "Example: ...",
"MCP Gateway: ...", linked headings — were left alone.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
@vrv-panw

Copy link
Copy Markdown
Contributor Author

Superseded by #1079, which lands phases 3, 4 and 5 against main in one PR. Every commit here is included there.

@vrv-panw vrv-panw closed this Sep 15, 2026
@vrv-panw
vrv-panw deleted the docs/prisma-airs-phase-5 branch September 15, 2026 12:12
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.

1 participant