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

Document new functional color system #225

Merged
merged 16 commits into from
Sep 3, 2021
Merged

Document new functional color system #225

merged 16 commits into from
Sep 3, 2021

Conversation

colebemis
Copy link
Contributor

@colebemis colebemis commented Aug 31, 2021

Problem

The Primer Primitives documentation site does not include clear documentation for our functional color system.

Solution

This PR adds documentation for the new functional color system (added in this PR)

Before

CleanShot 2021-09-03 at 13 37 44@2x

After

CleanShot.2021-09-03.at.13.40.06.mp4

@vercel
Copy link

vercel bot commented Aug 31, 2021

This pull request is being automatically deployed with Vercel (learn more).
To see the status of your deployment, click below or on the icon next to each commit.

🔍 Inspect: https://vercel.com/primer/primitives/9KBVT1DzdWSTYjqhXvt6fQdZfr43
✅ Preview: https://primitives-git-update-docs-primer.vercel.app

@changeset-bot
Copy link

changeset-bot bot commented Aug 31, 2021

⚠️ No Changeset found

Latest commit: b43bff2

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

@colebemis colebemis changed the title Document v2 variables Document new functional color system Sep 2, 2021
@colebemis colebemis marked this pull request as ready for review September 3, 2021 20:44
@colebemis colebemis requested a review from a team as a code owner September 3, 2021 20:44
@colebemis colebemis requested review from jonrohan and removed request for a team September 3, 2021 20:44
{variant === 'shadow' && <ShadowPreview name={name} value={value} />}
{variant === 'default' && <DefaultPreview name={name} value={value} />}
<Box sx={{fontFamily: 'mono', fontSize: 1, mt: 2}}>{name}</Box>
<Box sx={{fontFamily: 'mono', fontSize: 0, color: 'text.gray'}}>{`--${getFullName(
Copy link
Member

Choose a reason for hiding this comment

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

I wonder if we should wrap this in var(--color-fg-default) to make it more clear it's css? So it would look like this.
image

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Sounds good to me 👍


Use for Sponsors-related interfaces.

<SwatchGrid names={Object.keys(flatten(colors.light)).filter(key => key.split('.')[0] === 'sponsors')} />
Copy link
Member

Choose a reason for hiding this comment

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

Sponsors is it's own section?

docs/gatsby-config.js Outdated Show resolved Hide resolved
@colebemis colebemis merged commit 0e84436 into main Sep 3, 2021
@colebemis colebemis deleted the update-docs branch September 3, 2021 21:07
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.

2 participants