Skip to content

Commit fb2a4e6

Browse files
authored
docs(trac): Clarify schema.json limit (#1302)
<!-- Ticket number or summary of work --> # [DEVDOCS-] N/A ## What changed? <!-- Provide a bulleted list in the present tense --> * Adds a clarification that the 64 KB size limit for `schema.json` is calculated after the file has been minimized. ## Release notes draft <!-- Provide an entry for the release notes using simple, conversational language. Don't be too technical. Explain how the change will benefit the merchant and link to the feature. --> Clarified that the 64 KB size limit for `schema.json` applies to the minimized file size. ## Anything else? <!-- Add related PRs, salient notes, additional ticket numbers, etc. --> N/A ping {@rtalvarez}
1 parent 05974b1 commit fb2a4e6

1 file changed

Lines changed: 1 addition & 1 deletion

File tree

docs/storefront/stencil/themes/foundations/customizability.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ To prevent errors upon theme upload and avoid possible loss of customizations ma
9696
* **Single-instance restriction per storefront.** We strongly recommend opening only one instance of Theme Styles at a time against each storefront. We recommend this because there is currently no synchronization mechanism to reconcile configuration changes made by multiple Theme Styles instances. The `schema.json` file will record the last changes made by any instance, but changes saved earlier by other instances might be lost.
9797
* **Single-storefront restriction per editor.** In the current release, users can have only one storefront open in Theme Styles at a time. To bypass the cookie that imposes this restriction, a workaround is to open an "Incognito"/private-browsing window on an additional storefront.
9898
* **File name, location, and structure.** Your theme's `schema.json` file must be named `schema.json`. It must reside in the root of your theme directory and must be valid JSON.
99-
* **File size.** The maximum size for a `schema.json` file is 64 KB. Exceeding this limit will trigger an error upon uploading the theme to BigCommerce. Apart from this size constraint, there is no limit on the number of keys and values that you can place in a theme's `schema.json`.
99+
* **File size.** The maximum size for a `schema.json` file is 64 KB. The limit is calculated after the file has been minimized. Exceeding this limit will trigger an error upon uploading the theme to BigCommerce. Apart from this size constraint, there is no limit on the number of keys and values that you can place in a theme's `schema.json`.
100100

101101
## Managing keys between versions
102102

0 commit comments

Comments
 (0)