Skip to content

Comments

Ticket/2109 modal documentation fix#2112

Open
dlescarbeau wants to merge 2 commits intodevelopfrom
ticket/2109-modal-documentation-fix
Open

Ticket/2109 modal documentation fix#2112
dlescarbeau wants to merge 2 commits intodevelopfrom
ticket/2109-modal-documentation-fix

Conversation

@dlescarbeau
Copy link
Contributor

Fixes warnings that are generated when the javascript documentation site is created.

  • Updates modal documentation to show the main comment
  • Updates accordion documentation to export the AccordionOptions type

General:

  • I have reviewed the acceptance criteria defined in the ticket and ensured the work has been completed.
  • The commit message passes all quality commit message standards.
  • Unit tests have been updated or created to reflect any javascript changes.
  • Storybook scenarios have been updated or created to reflect any html/css/js changes.

Accessibility:

  • WCAG 2.1 Level AA requirements have been met.

Development:

  • Any new or updated javascript code has 100% unit test coverage.
  • New or updated breakpoints have regression images.
  • Breaking changes have been thoroughly documented in the PR.

Product Reviewer PR Checklist

Items the product team is responsible for reviewing.

General:

  • There are no unexpected or unapproved regression image changes.

  • Functionality of interactive elements meet the acceptance criteria.
  • The product is visually and functionally the same across the different browsers.

Accessibility:

  • AxeDev Tools: there are no new or outstanding accessibility issues introduced in this PR.
  • Lighthouse: scores have not noticeably decreased during this PR.
  • Wave: there are no new errors or contrast errors introduced in this PR.

Design Reviewer PR Checklist

Items the design team is responsible for reviewing. 


General:

  • New or updated features introduced in this PR are developed mobile-first.
  • Breakpoint changes and regression images match those breakpoints.
  • This PR has been tested in all supported browsers at all breakpoints.

Developer Reviewer PR Checklist

Items the development team is responsible for reviewing.

General:

  • New code passes code quality standards set by industry standards.
  • The expected Storybook stories have been added or updated for the new or updated feature.
  • The expected unit tests have been added or updated for the new or updated feature.

Accessibility:

  • VoiceOver: Described content matches with what was expected.
  • Keyboard navigation: new or updated features and content are navigable via the keyboard.

@github-actions
Copy link

2 similar comments
@github-actions
Copy link

@github-actions
Copy link

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