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
This pull request includes several changes to improve the documentation and build processes for UI components in the
ui-extensions
package. The changes primarily focus on adding new scripts, updating documentation generation processes, and including new examples for components.Documentation and Build Process Improvements:
New Build Script for Admin UI Extensions:
build-ab-docs.sh
to generate documentation for admin UI extensions, supporting both stable and unstable versions. The script handles various tasks including compiling docs, renaming files, and synchronizing withshopify-dev
paths.Updated
package.json
Scripts:docs:ab
script topackage.json
to generate documentation for admin UI extensions. [1] [2]Documentation Enhancements:
Improved Documentation Examples:
ReadMe.md
to use consistent heading levels for documentation commands, improving readability and structure.New Component Example:
Button
component inButton.doc.ts
and created a corresponding HTML filepreview.html
to demonstrate the component in action. [1] [2]Configuration Updates:
tsconfig.ab.docs.json
file to specify compiler options and include/exclude patterns for generating admin UI extension documentation.