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

chore(docs): add design systems section to documentation #3747

Merged
merged 30 commits into from
Aug 26, 2020
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
30 commits
Select commit Hold shift + click to select a range
ad13e70
add design systems section
nicholasrice Aug 19, 2020
bae4718
initial overview section
nicholasrice Aug 19, 2020
cec4208
adding creating-a-design-system section
nicholasrice Aug 20, 2020
ca7d244
document all design-system-provider properties
nicholasrice Aug 21, 2020
8fcb4f7
move color and typeramp documentation
nicholasrice Aug 21, 2020
2c3b621
shuffle content and flesh out fast frame design system portion
nicholasrice Aug 23, 2020
4d6cc1d
re-name export so that api-extractor does not get confused
nicholasrice Aug 23, 2020
b7d3a24
add color explorer docs
nicholasrice Aug 24, 2020
65a15fc
adding sections to using-the-design-system
nicholasrice Aug 24, 2020
72ff300
wrapping up using the design system section
nicholasrice Aug 24, 2020
611cf55
cleanup pass
nicholasrice Aug 24, 2020
7788e3d
addressing comments
nicholasrice Aug 25, 2020
4126cb0
adding design system to glossary
nicholasrice Aug 25, 2020
f6bf8d5
adding design system to glossary
nicholasrice Aug 25, 2020
b4ab55b
Merge branch 'master' into users/nirice/design-system-documentation
nicholasrice Aug 25, 2020
8711f27
Update sites/website/src/docs/design-systems/fast-frame.md
nicholasrice Aug 25, 2020
52bdeb9
Update sites/website/src/docs/design-systems/overview.md
nicholasrice Aug 25, 2020
1e4b005
Update sites/website/src/docs/design-systems/overview.md
nicholasrice Aug 25, 2020
a037c2e
Update sites/website/src/docs/design-systems/overview.md
nicholasrice Aug 25, 2020
eab75d4
Update sites/website/src/docs/design-systems/using-the-design-system.md
nicholasrice Aug 25, 2020
09c4cf1
Update sites/website/src/docs/design-systems/fast-frame.md
nicholasrice Aug 25, 2020
c87288b
Update sites/website/src/docs/design-systems/creating-a-design-system.md
nicholasrice Aug 25, 2020
e0df97e
Update sites/website/src/docs/design-systems/overview.md
nicholasrice Aug 25, 2020
4b935f9
Merge branch 'master' into users/nirice/design-system-documentation
nicholasrice Aug 25, 2020
f9676ff
Merge branch 'master' into users/nirice/design-system-documentation
nicholasrice Aug 26, 2020
79cc978
Merge branch 'master' into users/nirice/design-system-documentation
nicholasrice Aug 26, 2020
1b0ff64
Merge branch 'master' into users/nirice/design-system-documentation
awentzel Aug 26, 2020
30d81a9
Update sites/website/src/docs/design-systems/overview.md
nicholasrice Aug 26, 2020
814aa29
Update sites/website/src/docs/design-systems/fast-frame.md
nicholasrice Aug 26, 2020
1e0d7de
Update packages/web-components/fast-components/src/styles/recipes.ts
nicholasrice Aug 26, 2020
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
add design systems section
  • Loading branch information
nicholasrice committed Aug 19, 2020
commit ad13e70f60839ae6a7336a3fb334d946ce410e43
10 changes: 10 additions & 0 deletions sites/website/sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,16 @@ module.exports = {
"fast-element/next-steps",
],
},
{
type: "category",
label: "Working with Design Systems",
items: [
"design-systems/overview",
"design-systems/fast-frame",
"design-systems/using-the-design-system",
"design-systems/creating-a-design-system",
],
},
{
type: "category",
label: "Tools",
Expand Down
12 changes: 12 additions & 0 deletions sites/website/src/docs/design-systems/creating-a-design-system.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
id: creating-a-design-system
title: Creating a Design System
sidebar_label: Creating a Design System
custom_edit_url: https://github.com/microsoft/fast/edit/master/sites/website/src/docs/design-systems/creating-a-design-system.md
---
- Defining a DesignSystemProvider custom element
- Defining Design System properties
- default value
- CSS custom property name
- Common uses (design token)
- Other uses (font assets?)
19 changes: 19 additions & 0 deletions sites/website/src/docs/design-systems/fast-frame.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
---
id: fast-frame
title: The FAST Frame Design System
sidebar_label: FAST Frame
custom_edit_url: https://github.com/microsoft/fast/edit/master/sites/website/src/docs/design-systems/fast-frame.md
---
- What is FAST Frame
- A design system implementation of FAST Foundation.
- Comprehensive properties table with definitions and CSS custom property names (if applicable)
- Included use cases of properties
- Show examples where appropriate
- Configuring the FAST Frame Design System
- Setting value driven by content property
- Setting value driven by IDL property
- Coordinating color palettes and base colors
- Extending the FAST Frame Design System
- Create a new `DesignSystemProvider` that extends FASTDesignSystemProvider
- Declare new Design System properties
- Use element in HTML
31 changes: 31 additions & 0 deletions sites/website/src/docs/design-systems/overview.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
---
id: overview
title: Overview
sidebar_label: Overview
custom_edit_url: https://github.com/microsoft/fast/edit/master/sites/website/src/docs/design-systems/overview.md
---
- What is the Design System?
- Answers the question "What is a Design System in FAST and what is it for?"
- Captures information about UX design
- [Colors](https://www.fast.design/docs/design/color)
- Fonts and [font sizes](https://www.fast.design/docs/design/type-ramp)
- Motion
- Contrast preferences
- UI density
- etc...
- Stores Design Tokens
- How is the Design System used?
- Values represented as CSS custom properties
- Values represented as a JavaScript object
- Can be used for programmatic calculation. See "Using design system resolvers"
- Provided to components by a DesignSystemProvider
- What is the DesignSystemProvider?
- HTML element
- Creates CSS custom properties for Design System values
- Propagates Design System JavaScript object to descendent elements
- Resolves functions of the Design System to CSS custom properties
- [See color recipes](https://www.fast.design/docs/design/color#algorithmic-colors-recipes)
- `use-defaults` explained
- Explain "Adaptive UI"
- Describe property inheritance through document structure
- Using the DesignSystemProvider to configure and change the Design System
13 changes: 13 additions & 0 deletions sites/website/src/docs/design-systems/using-the-design-system.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
id: using-the-design-system
title: Using the FAST Design System
sidebar_label: Using the Design System
custom_edit_url: https://github.com/microsoft/fast/edit/master/sites/website/src/docs/design-systems/using-the-design-system.md
---
- Using design system CSS custom properties
- Using design system resolvers (CSS custom property behaviors, conditional CSS, etc)
- List the available Design System resolvers
- How to create a Design System resolver.
- When is this useful?
- Adaptive color
- Directional stylesheets