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

Overlay documentation fixes #2221

Merged
merged 3 commits into from
Aug 8, 2022
Merged

Conversation

josepmartins
Copy link
Contributor

Describe your changes here.

Tiny fixes on the Overlay documentation to avoid confusion, see #1971 (comment) or https://github.slack.com/archives/C01L618AEP9/p1658398312402499 @maximedegreve

  • Add an AnchoredOverlay link in the Overlay#Positioning documentation section.
  • Add an AnchoredOverlay item in the navigation.
  • Add/remove missing/non-existing props in the Overlay documentation.

Merge checklist

  • Added/updated tests
  • Added/updated documentation
  • Tested in Chrome
  • Tested in Firefox
  • Tested in Safari
  • Tested in Edge

Take a look at the What we look for in reviews section of the contributing guidelines for more information on how we review PRs.

@josepmartins josepmartins requested review from a team and mperrotti August 8, 2022 09:08
@changeset-bot
Copy link

changeset-bot bot commented Aug 8, 2022

🦋 Changeset detected

Latest commit: 6b0e19a

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

This PR includes changesets to release 1 package
Name Type
@primer/react Patch

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

@josepmartins josepmartins changed the title Josepmartins/docs overlay fixes Overlay documentation fixes Aug 8, 2022
@github-actions
Copy link
Contributor

github-actions bot commented Aug 8, 2022

size-limit report 📦

Path Size
dist/browser.esm.js 72.93 KB (0%)
dist/browser.umd.js 73.3 KB (0%)

@josepmartins josepmartins temporarily deployed to github-pages August 8, 2022 09:20 Inactive
@josepmartins josepmartins temporarily deployed to github-pages August 8, 2022 09:21 Inactive
Copy link
Member

@siddharthkp siddharthkp left a comment

Choose a reason for hiding this comment

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

I approve this message, ship it :shipit:

@maximedegreve
Copy link
Contributor

🎉

@josepmartins josepmartins merged commit 9ce6493 into main Aug 8, 2022
@josepmartins josepmartins deleted the josepmartins/docs-overlay-fixes branch August 8, 2022 10:06
@primer-css primer-css mentioned this pull request Aug 8, 2022
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.

3 participants