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

Manually corrects .docs.json files #5316

Merged
merged 2 commits into from
Nov 20, 2024
Merged

Conversation

mperrotti
Copy link
Contributor

Closes https://github.com/github/primer/issues/3258

Ideally we would automate our component API docs, but we seem to be a far way off from approving this ADR. In the meantime, we can manually correct our prop docs for the launch of the new docs site.

Changelog

No components are actually changing, just their API documentation.

New

Changed

Removed

Rollout strategy

  • Patch release
  • Minor release
  • Major release; if selected, include a written rollout or migration plan
  • None; if selected, include a brief description as to why

Testing & Reviewing

Merge checklist

@mperrotti mperrotti added the skip changeset This change does not need a changelog label Nov 19, 2024
@mperrotti mperrotti requested a review from a team as a code owner November 19, 2024 22:56
Copy link

changeset-bot bot commented Nov 19, 2024

⚠️ No Changeset found

Latest commit: d7f1b25

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

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

@github-actions github-actions bot added the integration-tests: recommended This change needs to be tested for breaking changes. See https://arc.net/l/quote/tdmpakpm label Nov 19, 2024
Copy link
Contributor

👋 Hi, this pull request contains changes to the source code that github/github depends on. If you are GitHub staff, we recommend testing these changes with github/github using the integration workflow. Thanks!

Copy link
Contributor

size-limit report 📦

Path Size
packages/react/dist/browser.esm.js 100.68 KB (0%)
packages/react/dist/browser.umd.js 101 KB (0%)

@mperrotti
Copy link
Contributor Author

Note to reviewers: focus on any prop documentation I may have added that we intentionally excluded. It would be take forever to manually confirm every update is correct.

Copy link
Contributor

@langermank langermank left a comment

Choose a reason for hiding this comment

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

🚀

@mperrotti mperrotti added this pull request to the merge queue Nov 20, 2024
Merged via the queue into main with commit 56ff1c0 Nov 20, 2024
50 checks passed
@mperrotti mperrotti deleted the mp/manually-correct-prop-docs branch November 20, 2024 19:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
integration-tests: recommended This change needs to be tested for breaking changes. See https://arc.net/l/quote/tdmpakpm skip changeset This change does not need a changelog
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants