-
Notifications
You must be signed in to change notification settings - Fork 209
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
docs: beginnings of jsdoc documentation and introduction of docs to storybook #5008
base: main
Are you sure you want to change the base?
Conversation
…ns (#4983) * docs(accordion): added missing JS doc for properties * docs(accordion): added copilot updates to JS Doc * docs(accordion): updated comments based on co-pilot recommendations * docs(action-bar): updated comments based on co-pilot recommendations * fix(action-button): updated comments based on co-pilot recommendations * docs(action-button): updated docs based on copilot * docs(action-menu): updated docs according to copilot recommendations * docs(action-bar): updated docs based on copilot recommendations * docs(alert-banner): updated based on copilot suggestions * docs(alert-dialog): updated based on copilot suggestions * docs: fixes to updated docs * docs: updated with suggestions from copilot
adds docs for several components and introduces jsdoc linting and updates to our eslint settings
|
Branch previewReview the following VRT differencesWhen a visual regression test fails (or has previously failed while working on this branch), its results can be found in the following URLs:
If the changes are expected, update the |
Lighthouse scores
What is this?Lighthouse scores comparing the documentation site built from the PR ("Branch") to that of the production documentation site ("Latest") and the build currently on Transfer Size
Request Count
|
Tachometer resultsChromeaccordion permalinkbasic-test
action-bar permalinkbasic-test
action-button permalinkbasic-test
action-group permalinkbasic-test
action-menu permalinktest-basic
test-directive permalink
test-lazy permalink
test-open-close-directive permalink
test-open-close permalink
alert-banner permalinkbasic-test
alert-dialog permalinkbasic-test
asset permalinkbasic-test
avatar permalinktest-basic
badge permalinkbasic-test
breadcrumbs permalinkbasic-test
button-group permalinkbasic-test
button permalinktest-basic
card permalinktest-basic
checkbox permalinktest-basic
coachmark permalinkbasic-test
color-area permalinkbasic-test
color-field permalinkbasic-test
color-handle permalinkbasic-test
color-slider permalinkbasic-test
color-wheel permalinkbasic-test
combobox permalinkbasic-test
light-dom-test permalink
contextual-help permalinkbasic-test
dialog permalinkbasic-test
divider permalinkbasic-test
dropzone permalinktest-basic
field-group permalinkbasic-test
field-label permalinkbasic-test
grid permalinkbasic-test
help-text permalinkbasic-test
icon permalinktest-basic
icons permalinktest-basic
illustrated-message permalinktest-basic
infield-button permalinkbasic-test
link permalinktest-basic
menu permalinktest-basic
meter permalinkbasic-test
number-field permalinkbasic-test
overlay permalinkbasic-test
directive-test permalink
element-test permalink
lazy-test permalink
picker-button permalinkbasic-test
picker permalinkbasic-test
popover permalinktest-basic
progress-bar permalinkbasic-test
progress-circle permalinkbasic-test
radio permalinktest-basic
search permalinktest-basic
sidenav permalinktest-basic
slider permalinktest-basic
split-view permalinkbasic-test
swatch permalinkbasic-test
switch permalinktest-basic
table permalinkbasic-test
tabs permalinkbasic-test
tags permalinkbasic-test
textfield permalinktest-basic
thumbnail permalinkbasic-test
toast permalinktest-basic
tooltip permalinktest-basic
test-directive permalink
test-element permalink
test-lazy permalink
top-nav permalinkbasic-test
tray permalinkbasic-test
truncated permalinkbasic-test
underlay permalinkbasic-test
Firefoxaccordion permalinkbasic-test
action-bar permalinkbasic-test
action-button permalinkbasic-test
action-group permalinkbasic-test
action-menu permalinktest-basic
test-directive permalink
test-lazy permalink
test-open-close-directive permalink
test-open-close permalink
alert-banner permalinkbasic-test
alert-dialog permalinkbasic-test
asset permalinkbasic-test
avatar permalinktest-basic
badge permalinkbasic-test
breadcrumbs permalinkbasic-test
button-group permalinkbasic-test
button permalinktest-basic
card permalinktest-basic
checkbox permalinktest-basic
coachmark permalinkbasic-test
color-area permalinkbasic-test
color-field permalinkbasic-test
color-handle permalinkbasic-test
color-slider permalinkbasic-test
color-wheel permalinkbasic-test
combobox permalinkbasic-test
light-dom-test permalink
contextual-help permalinkbasic-test
dialog permalinkbasic-test
divider permalinkbasic-test
dropzone permalinktest-basic
field-group permalinkbasic-test
field-label permalinkbasic-test
grid permalinkbasic-test
help-text permalinkbasic-test
icon permalinktest-basic
icons permalinktest-basic
illustrated-message permalinktest-basic
infield-button permalinkbasic-test
link permalinktest-basic
menu permalinktest-basic
meter permalinkbasic-test
number-field permalinkbasic-test
overlay permalinkbasic-test
directive-test permalink
element-test permalink
lazy-test permalink
picker-button permalinkbasic-test
picker permalinkbasic-test
popover permalinktest-basic
progress-bar permalinkbasic-test
progress-circle permalinkbasic-test
radio permalinktest-basic
search permalinktest-basic
sidenav permalinktest-basic
slider permalinktest-basic
split-view permalinkbasic-test
swatch permalinkbasic-test
switch permalinktest-basic
table permalinkbasic-test
tabs permalinkbasic-test
tags permalinkbasic-test
textfield permalinktest-basic
thumbnail permalinkbasic-test
toast permalinktest-basic
tooltip permalinktest-basic
test-directive permalink
test-element permalink
test-lazy permalink
top-nav permalinkbasic-test
tray permalinkbasic-test
truncated permalinkbasic-test
underlay permalinkbasic-test
|
Description
This is the work @nikkimk and I did for garage week last December. It introduces JS docs to start documenting our code and leverage the automated docs in a storybook. This will introduce doc pages for every component in a storybook, as well as a better-organized args table and code snippets on all stories for consuming engineers to use.
THIS SHOULD NOT BREAK ANY COMPONENTS OR TESTS.
Motivation and context
Begins to establish better documentation standards for our components and improve user experience in our storybook
How has this been tested?
Test case 1
Test case 2
Did it pass in Desktop?
Did it pass in Mobile?
Did it pass in iPad?
Screenshots (if appropriate)
Types of changes
Checklist
Best practices
This repository uses conventional commit syntax for each commit message; note that the GitHub UI does not use this by default so be cautious when accepting suggested changes. Avoid the "Update branch" button on the pull request and opt instead for rebasing your branch against
main
.