Skip to content

Adopt structured status tags and [!BETA]/[!DEPRECATED] callouts#3387

Draft
manovotny wants to merge 19 commits into
mainfrom
manovotny/wakeful-knuckle
Draft

Adopt structured status tags and [!BETA]/[!DEPRECATED] callouts#3387
manovotny wants to merge 19 commits into
mainfrom
manovotny/wakeful-knuckle

Conversation

@manovotny
Copy link
Copy Markdown
Contributor

🔎 Previews:

  • Pills/callouts render via the companion renderer (clerk/clerk#2621). Key pages to verify: /docs/reference/objects/sign-in & /sign-up (Legacy pill), /docs/reference/hooks/legacy/use-sign-in & /use-sign-up, plus the Clerk Elements and Expo native-components pages (deprecated/beta callouts).

What does this solve? What changed?

Status (beta, community, deprecated, legacy) was conveyed inconsistently — baked into titles ((beta), (Legacy)) and scattered across per-feature callout partials. This migrates the content to a structured tag frontmatter field plus standardized [!BETA] / [!DEPRECATED] callouts, which the renderer turns into status pills.

  • Tag enum — lowercased to beta | community | deprecated | legacy; parsed and validated in page frontmatter and the manifest; carried through generated SDK redirect pages.
  • Callouts — migrated ad-hoc beta/deprecation notices to [!BETA] / [!DEPRECATED]; deleted obsolete beta partials and updated their callers.
  • Retagging — Clerk Elements (beta → deprecated), deprecated reference pages, and Expo native-components (beta). The SignIn/SignUp objects and the legacy useSignIn/useSignUp hooks move from deprecated to legacy; their redundant "(Legacy)" title/manifest suffixes are dropped and their body callouts softened to [!WARNING].
  • Conventions — documented the tag field, [!BETA]/[!DEPRECATED], and inline status components in CONTRIBUTING/STYLEGUIDE.
  • Images — removed the baked-in beta tag from the Elements hero artwork (status is now the pill).

Renderer companion PR: clerk/clerk#2621 — it teaches the docs app these tags and must merge first. It's backward-compatible; this content PR is not safe to ship ahead of it (the deployed renderer would reject tag: legacy).

Deadline

  • No rush — but this must land after clerk/clerk#2621.

Other resources

manovotny and others added 17 commits April 24, 2026 09:37
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
…ETA]

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
…!DEPRECATED]

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
…!DEPRECATED]/[!BETA]

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
…egacy hooks

Adds `legacy` to the tag enum (used for both frontmatter and manifest validation). Retags the SignIn/SignUp object pages and the legacy useSignIn/useSignUp hooks from `deprecated` to `legacy`, strips the redundant "(Legacy)" suffix from the object titles and their manifest nav entries, and softens their body callouts from [!DEPRECATED] to [!WARNING]. The invalid-tag error message now derives from the enum so it can't drift.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
The beta status is now conveyed by the title/sidenav pill, so the tag no longer needs to be baked into the hero artwork.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@vercel
Copy link
Copy Markdown

vercel Bot commented May 20, 2026

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

Project Deployment Actions Updated (UTC)
clerk-docs Error Error May 22, 2026 5:57pm

Request Review

Brings content that landed on main since this branch diverged in line with the new status system:

- Agent Tasks (beta): flip the shared callout partial from [!WARNING] to [!BETA]; add tag: beta to the 4 agent-tasks pages (frontmatter) and the standalone guide/type manifest entries; the backend create/revoke inherit beta from their Agent Tasks manifest group. Converts the manifest's legacy '(Beta)' strings to the lowercase enum.
- Legacy custom-flow guides: add tag: legacy and strip the redundant '(Legacy)' suffix from the 13 custom-flows/authentication/legacy/*.mdx titles (status now conveyed by the pill + Legacy nav group).
- directory-sync: convert the two inline [!NOTE] 'is in public beta' notices to [!BETA] (page stays untagged; only those sub-features are beta).

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
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