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

Tomthorogood/md docs #3441

Merged
merged 6 commits into from
Jul 12, 2023
Merged

Tomthorogood/md docs #3441

merged 6 commits into from
Jul 12, 2023

Conversation

tomthorogood
Copy link
Contributor

@tomthorogood tomthorogood commented Jun 21, 2023

Renders markdown in documentation PropsTable components.

Closes #3302

Screenshots

Before:

Screenshot of the React Octicon component props table with unrendered markdown

After:

Screenshot of the React Octicon component props table with rendered markdown

Merge checklist

  • Added/updated tests N/A, doc rendering pipeline only
  • Added/updated documentation N/A
  • Changes are SSR compatible N/A
  • Tested in Chrome N/A
  • Tested in Firefox N/A
  • Tested in Safari N/A
  • Tested in Edge N/A

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

@changeset-bot
Copy link

changeset-bot bot commented Jun 21, 2023

🦋 Changeset detected

Latest commit: f219fb1

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

@github-actions
Copy link
Contributor

github-actions bot commented Jun 21, 2023

size-limit report 📦

Path Size
dist/browser.esm.js 102.31 KB (0%)
dist/browser.umd.js 102.88 KB (0%)

@tomthorogood tomthorogood temporarily deployed to github-pages June 21, 2023 21:41 — with GitHub Actions Inactive
@github-actions github-actions bot temporarily deployed to storybook-preview-3441 June 21, 2023 21:41 Inactive
@tomthorogood tomthorogood marked this pull request as ready for review June 21, 2023 21:54
@tomthorogood tomthorogood requested review from a team and mperrotti June 21, 2023 21:54
@tomthorogood tomthorogood self-assigned this Jun 21, 2023
@tomthorogood
Copy link
Contributor Author

tomthorogood commented Jun 21, 2023

Hmm, I realize now that the sx property description is different in my "After" screenshot; I'll take a look and see if that's in scope here, or if there was some other delta between what is deployed and what is being previewed.

Edit: It seems that the description is no longer included in the source json.

@broccolinisoup
Copy link
Member

Hmm, I realize now that the sx property description is different in my "After" screenshot; I'll take a look and see if that's in scope here, or if there was some other delta between what is deployed and what is being previewed.

Edit: It seems that the description is no longer included in the source json.

Hi @tomthorogood 👋🏻 We don't have sx value descriptions in the docs.json files for any of the components. Similar to as, ref etc. They all come from components-props.

if there was some other delta between what is deployed and what is being previewed

I think this is what is happening!

Copy link
Member

@broccolinisoup broccolinisoup left a comment

Choose a reason for hiding this comment

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

This looks good to me! Thanks so much for this PR 🙏🏻 There are some conflicts on the package*.json files, sorry we were a bit late to review your PR. Let us know if you need any support with the rest!

@broccolinisoup broccolinisoup temporarily deployed to github-pages July 7, 2023 02:43 — with GitHub Actions Inactive
@github-actions github-actions bot temporarily deployed to storybook-preview-3441 July 7, 2023 02:43 Inactive
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.

*.docs.json markdown links do not render on primer.style
2 participants