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

docs: add pseudo-docs for intended usage, and details on working with tokens #2088

Merged
merged 1 commit into from
Feb 24, 2023

Conversation

adamstankiewicz
Copy link
Member

Description

Follow-up docs task from #2086 (comment)

Deploy Preview

N/A

Merge Checklist

  • If your update includes visual changes, have they been reviewed by a designer? Send them a link to the Netlify deploy preview, if applicable.
  • Does your change adhere to the documented style conventions?
  • Do any prop types have missing descriptions in the Props API tables in the documentation site (check deploy preview)?
  • Were your changes tested using all available themes (see theme switcher in the header of the deploy preview, under the "Settings" icon)?
  • Were your changes tested in the example app?
  • Is there adequate test coverage for your changes?
  • Consider whether this change needs to reviewed/QA'ed for accessibility (a11y). If so, please add wittjeff and adamstankiewicz as reviewers on this PR.

Post-merge Checklist

  • Verify your changes were released to NPM at the expected version.
  • If you'd like, share your contribution in #show-and-tell.
  • 🎉 🙌 Celebrate! Thanks for your contribution.

@codecov
Copy link

codecov bot commented Feb 24, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 90.77%. Comparing base (9184d80) to head (5281e41).
Report is 1123 commits behind head on alpha.

Additional details and impacted files
@@           Coverage Diff           @@
##            alpha    #2088   +/-   ##
=======================================
  Coverage   90.77%   90.77%           
=======================================
  Files         213      213           
  Lines        3501     3501           
  Branches      843      843           
=======================================
  Hits         3178     3178           
  Misses        315      315           
  Partials        8        8           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Contributor

@viktorrusakov viktorrusakov left a comment

Choose a reason for hiding this comment

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

LGTM!

We'll probably need to expand the tokens README file, e.g. add additional documentation for type attribute, custom media queries, composite tokens, etc. But I think we should merge this as is just as a starting point 🙂

@adamstankiewicz
Copy link
Member Author

LGTM!

We'll probably need to expand the tokens README file, e.g. add additional documentation for type attribute, custom media queries, composite tokens, etc. But I think we should merge this as is just as a starting point 🙂

Agreed!

@adamstankiewicz adamstankiewicz merged commit 5159195 into alpha Feb 24, 2023
@adamstankiewicz adamstankiewicz deleted the ags/alpha-readme-docs branch February 24, 2023 12:15
@edx-semantic-release
Copy link
Contributor

🎉 This PR is included in version 21.0.0-alpha.14 🎉

The release is available on:

Your semantic-release bot 📦🚀

Copy link
Contributor

@brian-smith-tcril brian-smith-tcril left a comment

Choose a reason for hiding this comment

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

Looks like I'm late to the party but this looks wonderful!

Super excited to see the README in the tokens directory. Great stuff!

monteri pushed a commit to raccoongang/paragon that referenced this pull request Aug 17, 2023
PKulkoRaccoonGang pushed a commit to raccoongang/paragon that referenced this pull request Aug 18, 2023
@edx-semantic-release
Copy link
Contributor

🎉 This PR is included in version 22.0.0-alpha.1 🎉

The release is available on:

Your semantic-release bot 📦🚀

@openedx-semantic-release-bot

🎉 This PR is included in version 23.0.0-alpha.1 🎉

The release is available on:

Your semantic-release bot 📦🚀

@openedx-semantic-release-bot

🎉 This PR is included in version 23.0.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

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.

5 participants