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

[BD-46] feat: add initial documentation #1623

Conversation

monteri
Copy link
Contributor

@monteri monteri commented Sep 13, 2022

Description

Add documentation for Design Tokens in README.md and in the Design Tokens page in the Foundation section

Deploy Preview

Include a direct link to your changes in this PR's deploy preview here (e.g., a specific component page).

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.

@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Sep 13, 2022
@openedx-webhooks
Copy link

openedx-webhooks commented Sep 13, 2022

Thanks for the pull request, @monteri!

When this pull request is ready, tag your edX technical lead.

@monteri monteri linked an issue Sep 13, 2022 that may be closed by this pull request
2 tasks
@monteri monteri force-pushed the zadorozhnii/design-tokens-documentation branch from 92df213 to d52e388 Compare September 13, 2022 13:21
@codecov
Copy link

codecov bot commented Sep 13, 2022

Codecov Report

❗ No coverage uploaded for pull request base (feat/design-tokens@1ad0236). Click here to learn what that means.
Patch has no changes to coverable lines.

❗ Current head 8afdf1d differs from pull request most recent head d52e388. Consider uploading reports for the commit d52e388 to get more accurate results

Additional details and impacted files
@@                  Coverage Diff                  @@
##             feat/design-tokens    #1623   +/-   ##
=====================================================
  Coverage                      ?   91.57%           
=====================================================
  Files                         ?      208           
  Lines                         ?     3537           
  Branches                      ?      821           
=====================================================
  Hits                          ?     3239           
  Misses                        ?      283           
  Partials                      ?       15           

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

@monteri monteri changed the title feat: add initial documentation [BD-46] feat: add initial documentation Sep 14, 2022
@openedx-webhooks openedx-webhooks added blended PR is managed through 2U's blended developmnt program and removed open-source-contribution PR author is not from Axim or 2U labels Sep 14, 2022
@monteri monteri changed the base branch from feat/design-tokens to master September 14, 2022 09:22
@monteri monteri changed the base branch from master to feat/design-tokens September 14, 2022 09:22
@monteri monteri force-pushed the zadorozhnii/design-tokens-documentation branch from 8afdf1d to d52e388 Compare September 16, 2022 08:56
@viktorrusakov viktorrusakov merged commit a7173df into openedx:feat/design-tokens Sep 30, 2022
@openedx-webhooks
Copy link

@monteri 🎉 Your pull request was merged! Please take a moment to answer a two question survey so we can improve your experience in the future.

viktorrusakov pushed a commit that referenced this pull request Nov 1, 2022
@arbrandes arbrandes mentioned this pull request Feb 7, 2023
2 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
blended PR is managed through 2U's blended developmnt program
Projects
No open projects
Archived in project
Development

Successfully merging this pull request may close these issues.

Design tokens documentation
4 participants