Draft
Conversation
laurelthorburn
force-pushed
the
2025-10-gen-docs-v1
branch
from
f995d85 to
bcf764d
Compare
laurelthorburn
force-pushed
the
2025-10-gen-docs-v1
branch
from
784dd6c to
0da6efa
Compare
to component Props - Add v2ToArray in build-docs.mjs so transformJson works with generated_docs_data_v2.json (object format) - Add @publicdocs to admin component Props types in .d.ts for public docs generation Made-with: Cursor
… API types - build-docs.mjs: write extensions output as v2 format (arrayToV2) so types like ActionExtensionApi appear as top-level keys in generated_docs_data_v2.json - Add @publicdocs to admin API types: ActionExtensionApi, StandardApi, ShouldRenderApi, BlockExtensionApi, PrintActionExtensionApi, OrderRoutingRuleApi, PurchaseOptionsCardConfigurationApi, CustomerSegmentTemplateApi, IntentInvokeApi, ProductDetailsConfigurationApi, ProductVariantDetailsConfigurationApi, PickerApi, ResourcePickerApi, ResourcePickerOptions Made-with: Cursor
laurelthorburn
force-pushed
the
2025-10-gen-docs-v1
branch
3 times, most recently
from
6b75c9e to
b9721a0
Compare
laurelthorburn
force-pushed
the
2025-10-gen-docs-v1
branch
from
b9721a0 to
a7b7168
Compare
Copy generate-docs output to generated_docs_data_v2.json and run version replacement on the v2 file so downstream receives the v2 filename.
- Add @types/react resolution to deduplicate conflicting type declarations from @shopify/generate-docs dependency - Fix build-doc-shared.mjs to use absolute paths for generated file operations - Update build-docs.mjs to handle v2 JSON format (object or array) - Add @publicdocs annotations to api/docs.ts interfaces for doc generation - Fix doc reference types in authenticated-account.doc.ts and extension.doc.ts
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Background
Closes https://github.com/Shopify/shopify-dev/issues/68438
TL;DR: We are ready to begin the migration of POS docs to the latest major gen docs release.
Solution
Doc generation: Added
/** @publicDocs */immediately before every top level interface for POS ONLY.Why this approach: The existing doc pipeline uses
@publicDocsto decide what to include; adding the tag is the minimal, consistent fix and matches how other public API surfaces are documented.yarn docs:point-of-sale 2025-10to generate the generated docs data v2 json file in the shopify-dev repoChecklist