Generate TOML configuration schema docs#7040
Generate TOML configuration schema docs#7040ryancbahan wants to merge 1 commit into03-11-add-config-to-docgenfrom
Conversation
|
Warning This pull request is not mergeable via GitHub because a downstack PR is open. Once all requirements are satisfied, merge this PR as a stack on Graphite.
This stack of pull requests is managed by Graphite. Learn more about stacking. |
Coverage report
Test suite run success3833 tests passing in 1480 suites. Report generated by 🧪jest coverage report action from 272f55a |
Output of `pnpm generate-schema-docs` — doc/interface/example files for all app config sections and extension types, plus rebuilt generated_docs_data.json. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
d1ffff6 to
272f55a
Compare
|
We detected some changes at Caution DO NOT create changesets for features which you do not wish to be included in the public changelog of the next CLI release. |
Differences in type declarationsWe detected differences in the type declarations generated by Typescript for this branch compared to the baseline ('main' branch). Please, review them to ensure they are backward-compatible. Here are some important things to keep in mind:
New type declarationsWe found no new type declarations in this PR Existing type declarationspackages/cli-kit/dist/private/node/session.d.ts@@ -31,7 +31,7 @@ interface AppManagementAPIOauthOptions {
/**
* A scope supported by the Storefront Renderer API.
*/
-export type StorefrontRendererScope = 'devtools' | 'graphql';
+export type StorefrontRendererScope = 'devtools';
interface StorefrontRendererAPIOAuthOptions {
/** List of scopes to request permissions for. */
scopes: StorefrontRendererScope[];
|

WHY are these changes introduced?
Depends on #6979. Now that
pnpm generate-schema-docsexists as a standalone script, run it to produce the initial set of TOML configuration reference docs for shopify.dev.WHAT is this pull request doing?
Commits the output of
pnpm generate-schema-docs— 65 generated files:docs-shopify.dev/configuration/*.doc.ts— one consolidated app config page (9 sections: global, app_access, webhooks, app_proxy, point_of_sale, app_home, channel_config, customer_authentication, data) and 18 individual extension type pagesdocs-shopify.dev/configuration/interfaces/*.interface.ts— field type definitions for each section/extensiondocs-shopify.dev/configuration/examples/*.example.toml— example TOML snippetsdocs-shopify.dev/generated/generated_docs_data.json— rebuilt to include the new config pagesHow to test your changes?
pnpm build-dev-docssucceeds and includes config pages in the outputdocs-shopify.dev/configuration/, runpnpm generate-schema-docs, thenpnpm build-dev-docsMeasuring impact
Checklist