Skip to content

docs: plan versioning — managing company plans (Batch 2, SCHX-531)#348

Merged
ryanechternacht merged 3 commits into
plan-versioning-stagingfrom
docs/plan-versioning-batch-2-managing-plans
Jun 11, 2026
Merged

docs: plan versioning — managing company plans (Batch 2, SCHX-531)#348
ryanechternacht merged 3 commits into
plan-versioning-stagingfrom
docs/plan-versioning-batch-2-managing-plans

Conversation

@ryanechternacht

Copy link
Copy Markdown
Member

Part of the plan versioning docs overhaul (parent: SCHX-529). Batch 2 of 8.

What changed — catalog/management.mdx

  • Adds version migration as a source of a company plan change.
  • Documents that migrations follow the same guarantees as any plan change (entitlement limits + price updated to the new version with prorations, accrued usage and overrides preserved), and that companies left un-migrated are grandfathered onto their current version.
  • Notes that Manage Plan is version-aware: the company's current version shows on the profile (e.g. a "Pro v26" badge) and in the Manage Plan panel, and assigning a plan there uses its latest published version; moving a company to a specific older version is done via a version migration.

Screenshots (follow-up commit)

The existing management-manage-plan.png is stale (old centered modal + old top-nav; no version pill). I've captured the current version-aware Manage plan slide-over and will push it as a follow-up commit to this branch.

The other management-* images (non-Stripe Manage Plan, plan-audience, Stripe-mapping) are aged from the general UI refresh (not versioning-specific). I'll refresh those in the broader screenshot pass — flagging here so they're not forgotten.

Note: links to #plan-version-migrations resolve once Batch 1 (#347) merges.

🤖 Generated with Claude Code

- Add version migration as a source of company plan changes
- Document that migrations follow the same rules (entitlements/price updated,
  usage + overrides preserved) and that un-migrated companies are grandfathered
- Note that Manage Plan is version-aware (shows the plan version, assigns the
  latest published version) and link to version migrations for older versions

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@github-actions

Copy link
Copy Markdown
Contributor

Replace the stale (2025-02-12) centered Manage Plan modal with the current
right-side slide-over, which shows the plan version selector ("Pro v26
(latest)") now that plans are versioned. Matches the version-aware copy
already added to this page.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@github-actions

Copy link
Copy Markdown
Contributor

@ryanechternacht ryanechternacht changed the base branch from main to plan-versioning-staging June 11, 2026 20:38
@ryanechternacht ryanechternacht merged commit 8f86bbe into plan-versioning-staging Jun 11, 2026
1 check passed
@ryanechternacht ryanechternacht deleted the docs/plan-versioning-batch-2-managing-plans branch June 11, 2026 20:42
@github-actions

Copy link
Copy Markdown
Contributor

ryanechternacht added a commit that referenced this pull request Jun 25, 2026
* docs: plan versioning — core model (Batch 1, SCHX-530) (#347)

* docs: update core plan versioning model for launch (SCHX-530)

Rewrite the canonical plan versioning docs to match the shipped UI:
- Use the in-app version statuses (Draft / Published / Archived) and the
  version selector on the plan page
- Fix the dangling "More details can be found in" sentence in plans.mdx
- Describe the banner-based Publish flow and the Review changes step
- Replace the old 2-option subscriber migration with the shipped 3-option flow
  (Migrate all / Choose which companies / Keep all, incl. grandfathering)
- Document the Migrations tab and standalone migrations
- Refresh catalog-plan-versions-migration-1.png to the current 3-option screen

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

* small edits to de-aify the writing

---------

Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

* docs: plan versioning — managing company plans (Batch 2, SCHX-531) (#348)

* docs: reconcile Managing Company Plans with plan versioning (SCHX-531)

- Add version migration as a source of company plan changes
- Document that migrations follow the same rules (entitlements/price updated,
  usage + overrides preserved) and that un-migrated companies are grandfathered
- Note that Manage Plan is version-aware (shows the plan version, assigns the
  latest published version) and link to version migrations for older versions

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

* docs: refresh Manage Plan screenshot with version-aware selector

Replace the stale (2025-02-12) centered Manage Plan modal with the current
right-side slide-over, which shows the plan version selector ("Pro v26
(latest)") now that plans are versioned. Matches the version-aware copy
already added to this page.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

* fix an ai blunder

---------

Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

* docs: plan versioning — catalog config, trials, add-ons (Batch 3, SCHX-533) (#349)

* docs: plan versioning for catalog config, trials, and add-ons (SCHX-533)

- configure-catalog: note Live Plans (and the Initial/Fallback/Trial Expiry
  plans) surface each plan's latest published version; new checkouts use it
  while existing companies stay on their version until migrated
- trials: editing a plan creates a new version, so changed trial config applies
  to companies that start on (or are migrated to) the new version
- add-ons: document that add ons are versioned independently of base plans
  (draft -> publish -> migrate), confirmed by per-add-on version pills in-app

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

* small updates

---------

Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

* docs: note draft/publish step in credit burndown setup guide (SCHX-534) (#350)

The credit burndown guide builds a brand-new plan but never mentioned that it
starts as an unpublished draft (v1) and must be published before customers can
use it. Add a publish note before the catalog step. guides-first-plans already
reflects the draft -> save -> publish flow, so no change needed there.

Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

* docs: plan versioning — developer/API reference (Batch 6, SCHX-536) (#351)

* docs: document plan versioning in developer/API reference (SCHX-536)

Grounded in schematic.yaml:
- plan.mdx: add a "Plan versions" section — PlanVersion has `version` (int) and
  `status` (published/draft/archived); detailed plan responses expose
  `active_version` and `draft_version`. (Fields are snake_case, and live on the
  detail response, not the base PlanResponseData.)
- concepts.mdx: note a company is on a specific plan version; plans/add ons are
  versioned (draft -> published -> archived) with migration on publish
- company.mdx: clarify a company is assigned a specific plan version

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

* i don't like these changes, but we need to updates these api docs more holistically

---------

Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

* docs: explain version-specific Stripe prices under plan versioning (SCHX-537) (#352)

- stripe-overview + stripe-integration-guide: the base Stripe product is shared
  across a plan's versions, but prices are version-specific. Publishing a new
  version with a pricing change creates new Stripe prices and leaves existing
  ones intact, so companies on older versions keep their pricing until migrated;
  archiving a version deactivates its prices.

Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

* docs: refresh feature management + full quickstart for single-panel flow (Batch 5, SCHX-535) (#353)

* docs: update feature setup copy for single-panel create flow (SCHX-535)

The Create/Edit feature UI is now a single scrolling side panel (name,
description, type, flag key, and event in one form with a single "Create
feature" button), replacing the old multi-step "Continue" modal. Rewrite
the "Setting up Features" steps in features.mdx to match and consolidate
the create-flow images from three to two. Tweak the tracking-usage Event
step to reference the Event section in the edit panel.

Screenshot refreshes for this batch (feature homepage, policy, flag tab,
usage tab, create flow, entitlement editor) follow in a separate commit.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

* Refresh feature-management screenshots for current UI

Recapture the 9 feature-management and quickstart feature screenshots
from the live app to match the current single-panel feature create/edit
flow and version-aware UI. Pairs with the copy rewrite in 69d7be0.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

* remove unused items

* Update quickstart guide copy for current UI; remove orphaned images

Rewrite the quickstart feature flows to match the single-panel feature
create/edit UI (was a multi-step "Continue" modal) and the current
left-hand navigation and Monetization Settings entitlement editor:

- entitling-a-feature: single-panel boolean create + click-a-plan entitle
- tracking-usage: single-panel event create (flag + event) + numerical
  usage entitlement via the Monetization Settings panel
- account-setup: Settings is the gear at the bottom of the left nav,
  not a top-right gear icon
- create-a-component: match the "Define component" dialog (name, then
  Choose template) and "Create Component" button label
- setup-sdk: fix "Add Pns" typo and drop the stray bare list item

Delete 5 orphaned quickstart screenshots no longer referenced by any
page (components-builder, plan-audience, plan-creation, plan-mapping,
stripe-import).

Screenshot refreshes for the referenced quickstart images follow in a
separate commit.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

* Refresh quickstart screenshots to match current app and account

Recapture all 13 referenced quickstart images from the live
DashAI/Production account: boolean feature create + entitlement
(single-panel flow, Monetization Settings), event feature create +
entitlement, API keys list, both component-builder steps, the pricing
table preview, and the company last-seen header.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

* Align entitlement copy with the refreshed screenshots

The entitlement screenshots illustrate the Entitlements tab and
Monetization Settings panel using existing features (Video Generation,
AI Conversations) on real plans, so reword the steps to describe what
the images actually show and drop the stale "Demo Plan" reference. Also
make the usage allowance generic instead of hardcoding 25, which no
longer matched the example.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

---------

Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

---------

Co-authored-by: Claude Opus 4.8 (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