Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update ab doc gen #2691

Merged
merged 3 commits into from
Mar 20, 2025
Merged

Update ab doc gen #2691

merged 3 commits into from
Mar 20, 2025

Conversation

Fionoble
Copy link
Contributor

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:

    • Added a new script 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 with shopify-dev paths.
  • Updated package.json Scripts:

    • Added docs:ab script to package.json to generate documentation for admin UI extensions. [1] [2]

Documentation Enhancements:

  • Improved Documentation Examples:

    • Updated ReadMe.md to use consistent heading levels for documentation commands, improving readability and structure.
  • New Component Example:

    • Added a new preview example for the Button component in Button.doc.ts and created a corresponding HTML file preview.html to demonstrate the component in action. [1] [2]

Configuration Updates:

  • TypeScript Configuration for Documentation:
    • Added a new tsconfig.ab.docs.json file to specify compiler options and include/exclude patterns for generating admin UI extension documentation.

@Fionoble Fionoble force-pushed the fio/update-ab-doc-gen branch 2 times, most recently from 32f3b00 to 0a774ee Compare March 15, 2025 12:49
@Fionoble Fionoble force-pushed the fio/fix-doc-gen branch 2 times, most recently from 01d65d5 to 98ca523 Compare March 15, 2025 14:24
@Fionoble Fionoble force-pushed the fio/update-ab-doc-gen branch 3 times, most recently from 6b33852 to d8d1a83 Compare March 16, 2025 12:55
Copy link
Member

@alex-page alex-page left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks great. I think we could consolidate and remove some of my more scrappy approaches that didn't understand how all the pieces fit together.

@Fionoble Fionoble force-pushed the fio/fix-doc-gen branch 2 times, most recently from fed3f68 to 94fde8e Compare March 17, 2025 18:01
@Fionoble Fionoble force-pushed the fio/update-ab-doc-gen branch 4 times, most recently from ecb8820 to 2dec8b3 Compare March 17, 2025 20:58
@Fionoble Fionoble changed the base branch from fio/fix-doc-gen to 2025-07-rc March 18, 2025 15:00
@Fionoble Fionoble force-pushed the fio/update-ab-doc-gen branch 3 times, most recently from 8264a55 to a1331f7 Compare March 19, 2025 15:54
@Fionoble Fionoble force-pushed the fio/update-ab-doc-gen branch 2 times, most recently from 31e81bb to 42945d2 Compare March 20, 2025 00:23
@Fionoble Fionoble force-pushed the fio/update-ab-doc-gen branch from 42945d2 to b49e401 Compare March 20, 2025 00:27
@Fionoble Fionoble merged commit 06020a7 into 2025-07-rc Mar 20, 2025
4 checks passed
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.

2 participants