[Components content]: Default example descriptions for 2024-10#3961
Open
[Components content]: Default example descriptions for 2024-10#3961
Conversation
prepare customer account 2024-07 release
[checkout] Add cart instructions API
Add cart instructions API docs (2024-07)
Version Packages (2024-07)
updates instructions-update page
Doc changes for `purchase.checkout.shipping-option-item.render-after`
[2024-07] Fix doc generation on localdev
update generate-doc verision for 2024-07
fix build-docs file to run gh action
Fix docs building in CI
properly supports double square brackets.
Fix docs building in Spin [2024-07]
…out-asset Update one page checkout asset on `.dev` docs for `2024-07` API version
[2024-07] Escape double quotes in config documentation
…rop-descriptions [POS UI extensions]: Improved target, API, and component descriptions for 2024-07
* IA for Target APIs and components * linting * Fix docs generation * Remove new component docs
* Add and improve descriptions for Target APIs * Resource Picker API revisions * Description feedback from Steve Revamp limitations + best practices Further revisions Revise newly added descriptions (cherry picked from commit b1ffa70) Fixes: Type fixes Fix docs generation (cherry picked from commit 812f1b2) (cherry picked from commit 7706f01) (cherry picked from commit a9fa908) (cherry picked from commit 8665a41) (cherry picked from commit 9ae8b84) Co-authored-by: Cursor <[email protected]> * Remove accidentally added types * Integrate feedback from Steve --------- Co-authored-by: Cursor <[email protected]>
…path-2024-07 chore: update shopify-dev asset path
…-docs-2024-07 chore: update all paths in build-docs scripts 2024-07
Co-authored-by: Cursor <[email protected]>
[Target APIs content]: Examples and descriptions for 2024-07
… handling to targets.json scripts - Customer-account: Add generic recursive component parsing for AllComponents - Correctly resolves to 63 customer-account components (not checkout's 60) - Excludes Chat (not in shared-checkout-components.ts) - Includes local components (Card, Avatar, etc.) - Excludes @internal components (PolicyModal) - Admin: Add RunnableExtension support for should-render targets (27 new targets) - Admin: Add parseInlineComponentTypes for Pick/Omit handling - CustomerSegmentTemplateComponent correctly has 2 components - AllComponents correctly excludes 3 omitted components - Checkout: Add RunnableExtension support for address-autocomplete targets - Checkout: Add @Private target exclusion - POS: Add parseInlineComponentTypes for Pick handling - ActionComponents correctly has 1 component (Button) - SmartGridComponents correctly has 1 component (Tile) - All scripts: Add @Private JSDoc exclusion for targets
2024-07 target docs
Treat composite APIs as wrapper types: expand their constituent APIs in the generated targets but do not list composite names in per-target apis or API reverse mappings.
(cherry picked from commit c04d337)
* Make API headings consistent for Admin UI Co-authored-by: Cursor <[email protected]> * Make API headings consistent for POS UI Co-authored-by: Cursor <[email protected]> Minor fixes Remove files Update remaining POS API headings to Methods Co-authored-by: Cursor <[email protected]> * Remove reference to non-existent loading prop on Button Co-authored-by: Cursor <[email protected]> * Rename 'Methods' to 'Properties' in API headings and descriptions Co-authored-by: Cursor <[email protected]> * Remove 'methods' from API description text, use 'properties' instead Co-authored-by: Cursor <[email protected]> * Revert title for applyMetafieldChange back to original name Co-authored-by: Cursor <[email protected]> --------- Co-authored-by: Cursor <[email protected]>
Exclude ActionTargetApi and StandardApi from POS targets JSON
* Remove component name code styling * Linting
* Intros, best practices, limitations, and prop descriptions Linting Prop descriptions Linting Prop description improvements * Remove component name code styling Restore links + catch other code syntax instances Linting * Fix extension-targets.ts component name code styling Co-authored-by: Cursor <[email protected]> * Update selection-action target descriptions Co-authored-by: Cursor <[email protected]> * Incorporate feedback from Steve Co-authored-by: Cursor <[email protected]> * Integrate feedback from tech writers session Co-authored-by: Cursor <[email protected]> * Integrate feedback from Steve --------- Co-authored-by: Cursor <[email protected]>
Co-authored-by: Cursor <[email protected]>
[Components content]: Examples for 2024-07
Co-authored-by: Cursor <[email protected]>
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
19 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.
Summary
This PR adds new descriptions to the
defaultExampleof all 36 admin UI components for 2024-10.What changed
.doc.tsfiles updated withdescriptionfields indefaultExampleblockssubSections,definitions, or other fields modifiedMade with Cursor