Draft
Conversation
laurelthorburn
force-pushed
the
2024-07-gen-docs-v1
branch
from
8cfa986 to
bac3204
Compare
Made-with: Cursor
…l component Props - build-docs.sh: sed and copy use generated_docs_data_v2.json (generate-docs now outputs v2) - Add @publicdocs JSDoc to all admin component Props types and IconName so they appear in generated docs Made-with: Cursor
Copy generate-docs output to generated_docs_data_v2.json after generation so downstream gets the v2 filename. Library stays at 1.0.0.
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
4 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 2024-07to generate the generated docs data v2 json file in the shopify-dev repoChecklist
Documentation reference tracker: