chore(docs): add design systems section to documentation #3747
Conversation
nicholasrice
added
chore
nicholasrice
force-pushed
the
users/nirice/design-system-documentation
branch
from
0fab896 to
8fcb4f7
Compare
nicholasrice
requested review from
awentzel,
chrisdholt,
EisenbergEffect,
Falkicon and
janechu
as code owners
| sidebar_label: Overview | ||
| custom_edit_url: https://github.com/microsoft/fast/edit/master/sites/website/src/docs/design-systems/overview.md | ||
| --- | ||
| A *Design System* is somewhat of an amorphous term but can generally be thought of as a collection of resources for interactive media that promotes brand alignment. While that definition is intentionally broad, in UI development, Design Systems generally manifest as component libraries surrounded by usage guidance and design principles. |
There was a problem hiding this comment.
What about... "A Design System is a collection of resources for interactive media that promotes brand alignment. While that definition is intentionally broad, in UI development, Design Systems manifest as component libraries surrounded by usage guidance and design principles."
There was a problem hiding this comment.
The point is that there is a very broad definition in the industry about what a design system actually is - I'm not sure we want to declare the industry term here, just set the stage for how the term is used in FAST today
| custom_edit_url: https://github.com/microsoft/fast/edit/master/sites/website/src/docs/design-systems/using-the-design-system.md | ||
| --- | ||
|
|
||
| This section goes into further detail on how the Design System can be used. It will use [FAST Frame](/docs/design-systems/fast-frame) Design System in the examples but none are *specific* to [FAST Frame](/docs/design-systems/fast-frame); use these features with your own Design System if you're not using [FAST Frame](/docs/design-systems/fast-frame). |
There was a problem hiding this comment.
I feel like the first sentence is given already in the title. Would suggest removing
There was a problem hiding this comment.
Maybe could begin with "Using FAST Frame in the Design system" or some variation perhaps
There was a problem hiding this comment.
I added this to be sure folks didn't conflate this with documentation that is specific to FAST Frame because it is general purpose documentation. I think removing this would cause confusion between using the FAST Frame Design System and using any Design System
sites/website/src/docs/design-systems/using-the-design-system.md
Outdated
Show resolved
Hide resolved
sites/website/src/docs/design-systems/using-the-design-system.md
Outdated
Show resolved
Hide resolved
sites/website/src/docs/design-systems/creating-a-design-system.md
Outdated
Show resolved
Hide resolved
Co-authored-by: Rob Eisenberg <[email protected]>
Co-authored-by: Rob Eisenberg <[email protected]>
Co-authored-by: Rob Eisenberg <[email protected]>
Co-authored-by: Rob Eisenberg <[email protected]>
Co-authored-by: Rob Eisenberg <[email protected]>
Co-authored-by: Rob Eisenberg <[email protected]>
Co-authored-by: Rob Eisenberg <[email protected]>
EisenbergEffect
added
the
community:noteworthy
Co-authored-by: Jane Chu <[email protected]>
Co-authored-by: Jane Chu <[email protected]>
Description
Documentation for FAST's Design System implementation and architecture is fragmented and hard to follow. This PR adds a section to the documentation to specifically address questions surrounding:
I wasn't sure what to do with the remaining content in the "Design" section under "Using FAST Components" - if any one has any ideas there please chime in.
closes #3738
Motivation & context
Issue type checklist
Is this a breaking change?
Adding or modifying component(s) in
@microsoft/fast-componentschecklistProcess & policy checklist