Skip to content

Update Typography and Content component descriptions (2026-01)#4285

Open
sordaz00 wants to merge 1 commit into2026-01from
typography-web-components-2026-01
Open

Update Typography and Content component descriptions (2026-01)#4285
sordaz00 wants to merge 1 commit into2026-01from
typography-web-components-2026-01

Conversation

@sordaz00
Copy link
Copy Markdown
Contributor

Summary

  • Cascades Typography and Content component description updates from 2026-04-rc to 2026-01
  • Enriches shared property descriptions, converts @see tags to inline links, aligns with admin quality bar
  • Some individual .d.ts files already had rich descriptions from prior PRs — only shared file and remaining components updated

Test plan

  • yarn build passes
  • Verify no generated files included
  • Regen docs locally to verify descriptions

Made with Cursor

…uality

Updates JSDoc descriptions for Typography and Content web components
on the 2026-01 version branch. Enriches shared property descriptions,
converts @see tags to inline links, and aligns with admin quality bar.

Made-with: Cursor
@github-actions
Copy link
Copy Markdown
Contributor

🚨🚨🚨 Docs migration in progress 🚨🚨🚨

We are actively migrating UI extension reference docs to MDX in the areas/platforms/shopify-dev zone of the monorepo. This impacts docs for the following surfaces:

During this migration, please be aware of the following:

.doc.ts files are being deprecated. Changes to .doc.ts files in this repo will not be reflected in the new MDX-based docs. If you need to update docs for a reference that has already been migrated, make your changes directly in the areas/platforms/shopify-dev zone of the monorepo instead.

Doc comments in .ts source files (the comment blocks above types and functions) are also affected. Generating docs from these comments currently requires a newer version of the @shopify/generate-docs library that isn't yet available. Updates to doc comments may not produce the expected output until the migration is complete.

Examples that previously lived in this repo are being moved to the areas/platforms/shopify-dev zone of the monorepo and should be authored there going forward.

What should I do?

  • If your PR includes changes to .doc.ts files, doc comments, or examples, please reach out to us in #devtools-proj-templated-refs so we can help ensure your updates are captured correctly.
  • If your PR is limited to source code changes (non-docs), you can ignore this notice.

Thanks for your patience while we complete the migration! 🙏

@github-actions
Copy link
Copy Markdown
Contributor

We detected some changes in packages/*/package.json or packages/*/src, and there are no updates in the .changeset directory. If the changes are user-facing and should cause a version bump, run yarn changeset to track your changes and include them in the next release CHANGELOG. If you are making simple updates to repo configuration, examples, or documentation, you do not need to add a changeset.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant