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

Fix dev overlay UI Toolkit component names #8928

Merged
merged 4 commits into from
Oct 27, 2023

Conversation

HiDeoo
Copy link
Member

@HiDeoo HiDeoo commented Oct 26, 2023

Changes

This PR renames various dev overlay UI Toolkit components to fix a name discrepancy between the code and the docs.

For example, the docs mention astro-dev-overlay-window but the component was registered as astro-overlay-window. After checking with @Princesseuh on Discord, the -dev portion of the name is desired.

Testing

  • I tested manually by running the React example (after enabling the experimental feature and adding an image element with no alt attribute too).
  • I searched all references of astro-overlay- in the codebase and no results were found.

Docs

/cc @withastro/maintainers-docs for feedback!

  • I'm not quite confident about the changeset, should every renamed component be listed with the before/after name?
  • I'm also not sure about the semver bump considering it is an experimental feature so I went with patch for now.
  • The docs page will also need an update to fix various cases were a non -dev component name was used. I'll make a PR for this right after this one. Opened Fix dev overlay UI Toolkit component names docs#5206

@changeset-bot
Copy link

changeset-bot bot commented Oct 26, 2023

🦋 Changeset detected

Latest commit: 74a6601

The changes in this PR will be included in the next version bump.

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@github-actions github-actions bot added pkg: astro Related to the core `astro` package (scope) pr: docs A PR that includes documentation for review labels Oct 26, 2023
Copy link
Member

@sarah11918 sarah11918 left a comment

Choose a reason for hiding this comment

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

Thanks for noticing this @HiDeoo ! Corresponding docs PR has already been approved, so feel free to merge that one whenever this one is ready. (Tiny changeset suggestion)

.changeset/violet-ants-bow.md Outdated Show resolved Hide resolved
Co-authored-by: Sarah Rainsberger <[email protected]>
Copy link
Member

@Princesseuh Princesseuh left a comment

Choose a reason for hiding this comment

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

Oops

@Princesseuh Princesseuh merged commit ca90b47 into withastro:main Oct 27, 2023
13 of 14 checks passed
@astrobot-houston astrobot-houston mentioned this pull request Oct 27, 2023
natemoo-re added a commit that referenced this pull request Nov 22, 2023
Co-authored-by: Sarah Rainsberger <[email protected]>
Co-authored-by: Nate Moore <[email protected]>
Co-authored-by: Erika <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
pkg: astro Related to the core `astro` package (scope) pr: docs A PR that includes documentation for review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants