Catalyst docs accuracy corrections
We reviewed every Catalyst page against the current Catalyst source and corrected guidance that no longer matched how Catalyst works. Catalyst itself is unchanged; the pages now describe what you get today. Key corrections:
- Localization — locales are enabled in the control panel and picked up at runtime, with no code change or redeploy. The Static Translations and Multi-Language setup pages no longer describe editing
routing.ts, and now note that an enabled locale needs a message file or its pages return a 404 - Project layout — CLI-created projects are a standalone Next.js app, so paths, install commands, and the Vercel and testing setup no longer assume a
core/monorepo folder. Legacy monorepo projects are called out where they differ - Native Hosting —
catalyst deployruns GraphQL codegen itself, CI deploys must pass secrets with--secret, and scaffolding with--hosting commercealready creates your hosting project. See Native Hosting: Getting Started and GitHub Actions - Feature support — the Features table now shows wallet buttons on the cart page, order tracking links, and session sync from checkout as supported, and lists Catalyst’s analytics events accurately
- Reference — corrected defaults in Environment Variables (for example,
DEFAULT_REVALIDATE_TARGETis 3600 andCLIENT_LOGGERis on outside production) and added missing variables; documented client configuration, error classes, and retries in the Client reference; and updatedauth login,logs, and other commands in the CLI reference - Makeswift custom components — the Custom Components tutorial now uses the
register.tsandclient.tsxstructure that Catalyst ships - Contributing — Build an Integration now branches from
canary, the Catalyst repository’s default branch
Catalyst docs reorganized for clarity
The Storefront > Catalyst documentation has been reorganized so setup paths, Makeswift content, and reference material are easier to find.
- Clearer setup guidance — the Getting Started overview now contrasts One-Click Catalyst and CLI Installation, including how to get a Makeswift-connected project through the CLI with
--gh-ref @bigcommerce/catalyst-makeswift@latest - One-Click Catalyst alongside CLI Installation — both setup paths now sit side by side in Getting Started, running a One-Click project locally is now part of the One-Click Catalyst page, and a single Prerequisites page lists the local tools and control panel permissions they share
- Redirected Checkout moved to Deployment — how checkout domains work and how to launch a single storefront without Multi-Storefront now live in the Deployment overview
- Native Hosting recommended for deployment — Native Hosting is now listed first in the Deployment section and recommended across the Catalyst docs, with Vercel documented as the alternative. The Deployment overview compares the two, and the Vercel guide no longer assumes the older monorepo project structure
- Proxy page refreshed — the Proxy page (formerly Middleware) now walks through every step of the
proxy.tschain in order, and documents the UCP proxy: which paths it forwards to BigCommerce, why it must run first, and what to keep when customizingproxy.ts. It also gets a new section on the GraphQL proxy, which forwards client-side GraphQL requests, such as Checkout SDK wallet-button requests BIGCOMMERCE_STOREFRONT_UNAUTHENTICATED_TOKENdocumented — the Environment Variables reference now covers the private,Unauthenticated-scoped token the GraphQL proxy uses. The Catalyst CLI doesn’t set it, so add it yourself if you use the Checkout SDK on your storefront- New Makeswift section — consolidates Makeswift-specific content (editing and syncing content, custom components, the customer group component) that was previously scattered across several sections
- New Guides section — third-party integration guides (Mailchimp, Algolia, manually installing scripts) and the guide to manually creating a Catalyst channel with the REST Management API moved out of Getting Started into their own top-level section
- New Contributing section — content for developers contributing to the open-source Catalyst repository, separated from store-setup content
- Reorganized Reference and Features — Wishlists moved from Reference to Features, Environment Variables moved to Reference, and the one-page Content Management section folded into Features as Sitemap
- Beta Programs — the Experiments section (B2B Edition) is now named Beta Programs and flagged consistently with other beta content
Existing links to moved pages redirect automatically. For the full picture, start at Getting Started.
Makeswift on Catalyst Native Hosting
A new Native Hosting guide explains how a Makeswift-enabled Catalyst storefront’s Makeswift settings behave when you deploy it with the Catalyst CLI.
- The Makeswift site URL follows the channel. When
catalyst channels updateorcatalyst deploy --update-site-urlpoints a channel at your deployment, BigCommerce also updates the base URL of the Makeswift site connected to that channel. No change in the Makeswift dashboard is needed. - The API key is set by you. The CLI never changes
MAKESWIFT_SITE_API_KEY, so a deployment uses the key in.env.local, usually your development site’s. Store the production site’s key withcatalyst env add, and give the build the same key.
For details, see Makeswift.
Price list sale and retail prices of zero now return zero
Fixes a bug where the Storefront GraphQL API returned null for salePrice, and in some cases retailPrice, on Prices when the shopper’s price list record set that value to 0.
- Zero values from price lists are kept: when a price list record sets the sale price or retail price to
0, the matching field onPricesnow returns a zeroMoneyvalue instead ofnull. A sale price or retail price of0set on the product itself still returnsnull.
For details, see the Storefront GraphQL API reference.