chore: add additional component documentation for fast-foundation
#3203
Conversation
chrisdholt
requested review from
awentzel,
EisenbergEffect,
Falkicon,
janechu and
nicholasrice
as code owners
| ## Usage | ||
|
|
||
| ```html | ||
| <fast-dialog id="simpleDialog" aria-label="Simple modal dialog" modal="true"> |
There was a problem hiding this comment.
Is there a way to embed fixtures into these documents? I worry about these getting out of sync and it would be awesome to just reference a fixture.
There was a problem hiding this comment.
I'm sure we could copy them over somehow, but I'd want to scrub our fixtures and be sure they are always at a high quality. I lean a bit towards having these be a bit curated to start. This is even initial as I'm going to do a follow-up to try and have live-code examples as part of the readme.
There was a problem hiding this comment.
We could have our build process copy the fixture content into a designated location in the markdown file.
| ## Usage | ||
|
|
||
| ```html | ||
| <fast-dialog id="simpleDialog" aria-label="Simple modal dialog" modal="true"> |
There was a problem hiding this comment.
We could have our build process copy the fixture content into a designated location in the markdown file.
| @@ -4,6 +4,7 @@ title: fast-dialog | |||
| sidebar_label: fast-dialog | |||
| custom_edit_url: https://github.com/microsoft/fast-dna/edit/master/packages/web-components/fast-foundation/src/dialog/README.md | |||
| --- | |||
| A web component implementation of a [dialog](https://w3c.github.io/aria-practices/#dialog_modal) which can either be modal or non-modal. The modal | |||
There was a problem hiding this comment.
Dangling sentence here? It just says "The modal"
packages/web-components/fast-foundation/src/text-field/README.md
Outdated
Show resolved
Hide resolved
chrisdholt
force-pushed
the
users/chhol/add-additional-component-documentation
branch
from
d8e0070 to
497031d
Compare
Description
This PR adds additional component documentation and basic usage examples for fast-foundation.
Issue type checklist
Is this a breaking change?
Process & policy checklist