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

Generate App Bridge Docs #2687

Closed
wants to merge 1 commit into from
Closed

Generate App Bridge Docs #2687

wants to merge 1 commit into from

Conversation

alex-page
Copy link
Member

@alex-page alex-page commented Mar 14, 2025

Background

App Bridge is shipping experimental web components that use the same types and documentation as the Admin Extension components. This PR shims the doc generation to ensure they are both created from the same source of truth.

Solution

  • Replaced the Admin shell script with something easier to work with for complicated object transforms
  • Added a shim to generate App Bridge Experimental Web Components
  • Added some initial rough HTML examples for the App Bridge Experimental Web Components

🎩

Generate the Admin documentation

yarn docs:admin 2025-07-rc

Tophat the documentation in shopify-dev. You must have shopify-dev cloned locally to do this.

Checklist

  • I have 🎩'd these changes
  • I have updated relevant documentation

@alex-page alex-page force-pushed the app-bridge-doc-gen branch from 0b13d07 to ba12f1f Compare March 14, 2025 03:41
@alex-page alex-page force-pushed the app-bridge-doc-gen branch from ba12f1f to 6b8ba34 Compare March 14, 2025 03:53
@alex-page alex-page marked this pull request as ready for review March 14, 2025 04:00
@alex-page alex-page closed this Mar 25, 2025
@alex-page alex-page deleted the app-bridge-doc-gen branch March 25, 2025 05:48
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.

1 participant