Skip to content

Generate TOML configuration schema docs#7040

Open
ryancbahan wants to merge 1 commit into03-11-add-config-to-docgenfrom
03-12-generate-config-docs
Open

Generate TOML configuration schema docs#7040
ryancbahan wants to merge 1 commit into03-11-add-config-to-docgenfrom
03-12-generate-config-docs

Conversation

@ryancbahan
Copy link
Contributor

@ryancbahan ryancbahan commented Mar 18, 2026

WHY are these changes introduced?

Depends on #6979. Now that pnpm generate-schema-docs exists 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:

  • Doc pages: 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 pages
  • Interfaces: docs-shopify.dev/configuration/interfaces/*.interface.ts — field type definitions for each section/extension
  • Examples: docs-shopify.dev/configuration/examples/*.example.toml — example TOML snippets
  • Updated: docs-shopify.dev/generated/generated_docs_data.json — rebuilt to include the new config pages

How to test your changes?

  1. pnpm build-dev-docs succeeds and includes config pages in the output
  2. Files can be regenerated from scratch: delete docs-shopify.dev/configuration/, run pnpm generate-schema-docs, then pnpm build-dev-docs

Measuring impact

  • n/a - this doesn't need measurement, e.g. a linting rule or a bug-fix

Checklist

  • I've considered possible cross-platform impacts (Mac, Linux, Windows)
  • I've considered possible documentation changes

@ryancbahan ryancbahan mentioned this pull request Mar 18, 2026
3 tasks
Copy link
Contributor Author

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.
Learn more

This stack of pull requests is managed by Graphite. Learn more about stacking.

@ryancbahan ryancbahan changed the base branch from 03-11-add-config-to-docgen to graphite-base/7040 March 18, 2026 20:04
@ryancbahan ryancbahan changed the title generate TOML configuration schema docs Generate TOML configuration schema docs Mar 18, 2026
@github-actions
Copy link
Contributor

github-actions bot commented Mar 18, 2026

Coverage report

St.
Category Percentage Covered / Total
🟢 Statements 82.03% 14721/17945
🟡 Branches 74.44% 7306/9815
🟢 Functions 81.22% 3727/4589
🟢 Lines 82.44% 13922/16888

Test suite run success

3833 tests passing in 1480 suites.

Report generated by 🧪jest coverage report action from 272f55a

@ryancbahan ryancbahan marked this pull request as ready for review March 18, 2026 21:25
@ryancbahan ryancbahan requested review from a team as code owners March 18, 2026 21:25
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>
@ryancbahan ryancbahan force-pushed the 03-12-generate-config-docs branch from d1ffff6 to 272f55a Compare March 18, 2026 21:26
@ryancbahan ryancbahan changed the base branch from graphite-base/7040 to 03-11-add-config-to-docgen March 18, 2026 21:26
@github-actions
Copy link
Contributor

We detected some changes at packages/*/src and there are no updates in the .changeset.
If the changes are user-facing, run pnpm changeset add to track your changes and include them in the next release CHANGELOG.

Caution

DO NOT create changesets for features which you do not wish to be included in the public changelog of the next CLI release.

@github-actions
Copy link
Contributor

Differences in type declarations

We 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:

  • Some seemingly private modules might be re-exported through public modules.
  • If the branch is behind main you might see odd diffs, rebase main into this branch.

New type declarations

We found no new type declarations in this PR

Existing type declarations

packages/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[];

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