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

feat: design token and theme package documentation #103

Merged
merged 12 commits into from Sep 27, 2019

Conversation

@SiTaggart
Copy link
Collaborator

SiTaggart commented Sep 20, 2019

Add a page for each of the Design Token package and Theme package, with install instructions and how to use. Similar to a component or utility page.

Contributing to Twilio

All third-party contributors acknowledge that any contributions they provide will be made under the same open-source license that the open-source project is provided under.

  • I acknowledge that all my contributions will be made under the project's license.
@now

This comment has been minimized.

Copy link

now bot commented Sep 20, 2019

This pull request is automatically deployed with Now.
To access deployments, click Details below or on the icon next to each push.

Latest deployment for this branch: https://paste-git-feat-theme-package-docs.twilio-dsys.now.sh

Copy link
Collaborator

TheSisb left a comment

lgtm!

Copy link
Contributor

aayushpi left a comment

Some text suggestions for clarity and approachability.

@SiTaggart

This comment has been minimized.

Copy link
Collaborator Author

SiTaggart commented Sep 23, 2019

@aayushpi if you want to give it a pass I've done a once through now

</SiteNavItem>
<SiteNavItem>
<SiteNavAnchor to={`${SidebarCategoryRoutes.TOKENS}/how-to-compose-custom-ui-with-tokens`}>
How to compose custom UI with tokens

This comment has been minimized.

Copy link
@TheSisb

TheSisb Sep 24, 2019

Collaborator

image

This is kind of long. Can we rename it to `Composing with tokens`?

This comment has been minimized.

Copy link
@SiTaggart

SiTaggart Sep 24, 2019

Author Collaborator

Seems like an improvement to me but I'll wait for a consensus before changing it as it involves changing filenames and stuff and there maybe other ideas. @aayushpi @serifluous @two24studios for input


## The happy path

Obviously the first option is to work with your design partner and identify all the existing Paste components that can be used to create the experience. If you are struggling or have quesitons come to Design System Office Hours or post in the #help-design-system slack channel, we'll get you back on track.

This comment has been minimized.

Copy link
@TheSisb

TheSisb Sep 24, 2019

Collaborator

quesitons -> questions

This comment has been minimized.

Copy link
@TheSisb

TheSisb Sep 24, 2019

Collaborator

Should we link to info on Office Hours?

This comment has been minimized.

Copy link
@SiTaggart

SiTaggart Sep 24, 2019

Author Collaborator

Should we link to info on Office Hours?

Do we have a link?

{`<Box padding="space20">
<Text as="p" marginBottom="space40">Some text</Text>
<Text as="h1" fontSize="fontSize70" fontWeight="fontWeightMedium" lineHeight="lineHeight70" mb="space80">Custom heading</Text>
<Text as="ul" ml="space60">

This comment has been minimized.

Copy link
@TheSisb

TheSisb Sep 24, 2019

Collaborator

Should this be a Text or a Box?

If we're making it a Text, can we pass the fontSize to it and would the children elements receive the styling?

This comment has been minimized.

Copy link
@SiTaggart

SiTaggart Sep 24, 2019

Author Collaborator

So Text right now has a set default font-size, which matches what the system classes as the default body size. The reason being is that we font set a body size as you can't really override someone's application, and we don't actually know where this will be used so can't rely on any inheritance.

So even if I did set it on the ul, it won't currently affect the children as they set their own font-size anyway.

This comment has been minimized.

Copy link
@TheSisb

TheSisb Sep 25, 2019

Collaborator

Makes sense. Is there any guidelines or issues with making a ul element a Text as opposed to a Box though?

@now now bot temporarily deployed to staging Sep 24, 2019 Inactive
@now now bot temporarily deployed to staging Sep 26, 2019 Inactive
@aayushpi

This comment has been minimized.

Copy link
Contributor

aayushpi commented Sep 26, 2019

One down, three to go - design tokens package is edited

@aayushpi

This comment has been minimized.

Copy link
Contributor

aayushpi commented Sep 27, 2019

Added:

  • Text changes to Theme Package
  • Text changes to Design Tokens Package
  • Small rewrite to Guide for Custom UI
  • Rewrote package descriptions for theme and token.
@SiTaggart SiTaggart merged commit 3060113 into master Sep 27, 2019
5 checks passed
5 checks passed
Semantic Pull Request ready to be squashed
Details
ci/circleci: build Your tests passed on CircleCI!
Details
ci/circleci: prettier Your tests passed on CircleCI!
Details
ci/circleci: test Your tests passed on CircleCI!
Details
now Deployment has completed
Details
@SiTaggart SiTaggart deleted the feat/theme-package-docs branch Sep 27, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
4 participants
You can’t perform that action at this time.