Skip to content

docs(orders): remove the not-yet-GA banner - #381

Merged
aaitor merged 1 commit into
mainfrom
aaitor/orders-remove-banner
Sep 10, 2026
Merged

aaitor merged 1 commit into
mainfrom
aaitor/orders-remove-banner

Conversation

@aaitor

@aaitor aaitor commented Sep 10, 2026

Copy link
Copy Markdown
Member

Why this matters

The Orders merchant guide has carried a "Not yet generally available" banner since it shipped. At the maintainer's request this removes it, so the page reads as a normal, current guide rather than a preview. The change is availability-neutral: it drops the pre-GA framing without adding any "Orders is live" claim.

What changed

integrate/patterns/orders.mdx:

  • Removed the top <Warning> "Not yet generally available" banner.
  • Dropped the matching "while Orders is pre-GA" phrasing from the tutorial <Tip> and its Next steps card, keeping the still-true "runs against a local Nevermined stack" caveat.
  • Trimmed the hosted-checkout <Note>'s rollout-timing clause for the same consistency.

architecture.md: dropped the "marked not yet GA" tag on the Orders tracker line so it matches the page.

The Phase 2/3 "not available today" statements (server-side agent checkout, refund API, dispute handling) are unrelated and untouched — those features genuinely aren't built.

Note on timing (for the reviewer)

This is a maintainer decision (@aaitor asked for the banner removal explicitly). For transparency: as of 2026-09-10 the Orders route is still not mounted on api.live or api.sandbox (GET /api/v1/orders/<unknown> returns BCK.HTTP.404, not BCK.ORDER.0002). The page no longer flags availability either way and makes no "live now" claim, so it doesn't assert something false — but if the intent was to wait for the production deploy, this is a one-line revert.

Test plan

  • mint broken-linkssuccess no broken links found
  • No residual "pre-GA / not yet available" phrasing on the page (grep clean)
  • architecture.md tracker matches the page
  • Pre-PR deep review gate clean (0 blockers; the architecture.md consistency SHOULD-FIX was addressed)
  • Mintlify Deployment + link-rot green
  • Preview shows the page with no banner

🤖 Generated with Claude Code

https://claude.ai/code/session_0191AdKUQYVPGnM7bp4dCEFk

Removes the "Not yet generally available" Warning banner from the Orders
guide at the maintainer's request, and reconciles the two body phrasings that
carried the same pre-GA framing (the tutorial Tip and its Next-steps card) so
the page is internally consistent — the true "runs against a local Nevermined
stack" caveat for the tutorial is kept, only the GA-status framing is dropped.
The Note's rollout-timing clause is trimmed for the same reason.

The page now makes no availability claim either way; it does not assert Orders
is live. Phase 2/3 "not available today" statements are unrelated and untouched.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_0191AdKUQYVPGnM7bp4dCEFk
Copilot AI lite review requested due to automatic review settings September 10, 2026 07:48
@aaitor
aaitor requested a review from a team as a code owner September 10, 2026 07:48
@mintlify

mintlify Bot commented Sep 10, 2026

Copy link
Copy Markdown

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

Project Status Preview Updated
Nevermined 🟢 Ready View Preview Sep 10, 2026, 7:49 AM

💡 Tip: Enable Automations to automatically generate PRs for you.

Copilot AI left a comment

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.

🟢 Approval recommended

The changes are limited to wording/banner removal, are internally consistent, and do not introduce new availability claims beyond what the page already states.

Pull request overview

This PR updates the Orders merchant guide to remove “not yet generally available / pre‑GA” framing while keeping the documentation focused on the Phase 1 contract and local-stack caveats, and aligns the architecture tracker entry accordingly.

Changes:

  • Removed the top-level “Not yet generally available” <Warning> banner from the Orders guide.
  • Edited related wording in the hosted-checkout <Note>, tutorial <Tip>, and Next steps card to remove rollout/pre‑GA phrasing while retaining the “local Nevermined stack” requirement.
  • Updated architecture.md to remove the “marked not yet GA” tag from the Orders tracker line.
File summaries
File Description
integrate/patterns/orders.mdx Removes the pre‑GA banner and trims related rollout/pre‑GA phrasing while preserving the Phase 1/local-stack guidance.
architecture.md Updates the Orders tracker line to match the page’s revised availability-neutral framing.
Review details
  • Files reviewed: 2/2 changed files
  • Comments generated: 0
  • Review effort level: Lite

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

@r-marques

Copy link
Copy Markdown
Member

👀 Reviewing

@r-marques r-marques left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

🤖 Automated PR review — 🟡 Mergeable with nits

Removing the banner is correct, and I verified that rather than taking it: the Orders epic #3238 closed 2026-09-07, its last open piece #3249 (the Privy-free embed Order checkout) closed the same day, and the hosted-checkout route is on main at apps/embed/src/routes/checkout.order.$orderId.tsx. The two should-fix items are both about things the banner was covering rather than anything the edit got wrong.

What I verified

  • Diff range origin/main...HEAD — 2 files, +4/−8, head 8e5048cb.
  • The removal is complete. not yet generally available / not-yet-GA / pre-GA / not enabled in production / rolled out to organizationzero matches repo-wide after this change, across .md, .mdx and .json.
  • The audience gate survives correctly. Prerequisites (:26, untouched) still states Orders is organization-only and that a personal key is refused with BCK.ORDER.0003 — which matches order-env.ts's own header: eligibility is gated on active-organization membership (#3313), not an env var. So there's no deployment flag whose state could contradict the page.
  • I checked the linked tutorial and it disagrees with this page — its README still calls Orders "a feature in progress… not yet in a released sandbox/live environment" and tells you to build from aaitor/orders-embed-checkout-3249. That branch is gone (404) and both issues are closed, so the README is the stale artefact, not this PR. Raised as should-fix #1 because this PR rewrites both sentences that point at it.
  • api-reference/openapi.json has no Orders entry — parsed, not grepped: 32 paths, the only order-shaped one is /protocol/plans/{planId}/order (the plan order). No Orders coverage anywhere under api-reference/.
  • architecture.md is not in docs.json's nav, so that edit is internal-only and carries no reader-facing risk.

One thing I could not determine: whether Orders is serving in a deployed environment right now. I tried an unauthenticated existence probe against api.nevermined.app and api.sandbox.nevermined.app and got no response at all from this sandbox — no egress — so that's "could not determine", not "not deployed". The closed epic and the merged route are what I'm relying on, and the rollout call is yours in any case.

No agent panel this round; I stood this on direct verification and would rather say so than imply coverage I did not have.

Verdict: 🟡 Mergeable with nits — 0 blockers, 2 should-fix, 0 nits.

🧭 Inline comments (3)

Each is posted on its line in Files changed.

  • 🟡 SHOULD FIX — Both tutorial pointers now route readers to a README that still says Orders is pre-GA and names a deleted branch — integrate/patterns/orders.mdx:67
  • 🟡 SHOULD FIX — Orders has no entry in the published API reference, and the banner was the only thing explaining the silence — integrate/patterns/orders.mdx:63
  • NICE — Splitting the banner's two jobs and keeping the audience gate is the right call — integrate/patterns/orders.mdx:64

Comment thread integrate/patterns/orders.mdx
Comment thread integrate/patterns/orders.mdx
@@ -64,11 +60,11 @@ Your server sets the price. The buyer's browser confirms the payment. A Stripe w
</Steps>

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

✅ NICE — Splitting the banner's two jobs and keeping the audience gate is the right call

Worth naming because it's the part that could easily have gone wrong. The removed <Warning> was doing two different jobs: a temporal hedge ("not enabled in production yet") and an audience gate ("being rolled out to organization accounts"). Only the first is now false.

The second survives exactly where it belongs — Prerequisites, :26, untouched by this PR:

An active organization account. Orders are available to organizations only. A personal API key is refused with BCK.ORDER.0003.

And that matches the implementation rather than merely sounding right. apps/api/src/orders/order-env.ts says so in its header: "Eligibility to create orders is gated on active-organization membership (#3313), not an env var; these knobs are the per-merchant caps…" — so there is no global on/off flag whose state could contradict the page; the restriction is per-caller and is documented as such.

The sweep is also complete: not yet generally available / not-yet-GA / pre-GA / not enabled in production / rolled out to organization return zero matches repo-wide after this change, .md/.mdx/.json alike. And dropping "While Orders is pre-GA" from the tutorial sentences while keeping the local-stack fact is the safer direction — a wrong reason would have been worse than none.

Anchored at line 64; the finding refers to integrate/patterns/orders.mdx:63, which is outside this PR's diff hunks.

🤖 pr-review-toolkit · direct-verification · high

@r-marques
r-marques disabled auto-merge September 10, 2026 07:56

@r-marques r-marques left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

🟡 Approved with comments — no blockers; 2 should-fix, 0 nit(s) left inline. Auto-merge was disabled so these can be looked at first.

Inline review: #381 (review)

@aaitor
aaitor merged commit 3e7511a into main Sep 10, 2026
4 checks passed
@aaitor
aaitor deleted the aaitor/orders-remove-banner branch September 10, 2026 08:00
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.

3 participants