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

docs: updated documentation for Calendar and DateTimePicker components #5001

Merged
merged 11 commits into from
Dec 24, 2024

Conversation

mizgaionutalexandru
Copy link
Contributor

@mizgaionutalexandru mizgaionutalexandru commented Dec 23, 2024

Description

Updating the documentation of the new components: Calendar and DateTimePicker according to implemented features for the initial release.

Also, the storybook was updated to include the locale picker using the chromatic globals settings.

Related issue(s)

Motivation and context

Ease of use.

How has this been tested?

Main changes has been tested in Storybook and on the local docs server.

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Chore (minor updates related to the tooling or maintenance of the repository, does not impact compiled assets)

Checklist

  • I have signed the Adobe Open Source CLA.
  • My code follows the code style of this project.
  • If my change required a change to the documentation, I have updated the documentation in this pull request.
  • I have read the CONTRIBUTING document.
  • I have added tests to cover my changes.
  • All new and existing tests passed.
  • I have reviewed at the Accessibility Practices for this feature, see: Aria Practices

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.

Copy link

changeset-bot bot commented Dec 23, 2024

⚠️ No Changeset found

Latest commit: ca24fad

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Copy link

Branch preview

Review the following VRT differences

When 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 current_golden_images_cache hash in the circleci config to accept the new images. Instructions are included in that file.
If the changes are unexpected, you can investigate the cause of the differences and update the code accordingly.

@mizgaionutalexandru mizgaionutalexandru marked this pull request as ready for review December 23, 2024 10:16
@mizgaionutalexandru mizgaionutalexandru requested a review from a team as a code owner December 23, 2024 10:16
Copy link

github-actions bot commented Dec 23, 2024

Lighthouse scores

Category Latest (report) Main (report) Branch (report)
Performance 0.99 0.98 0.99
Accessibility 1 1 1
Best Practices 1 1 1
SEO 1 0.92 0.92
PWA 1 1 1
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 main ("Main"). Higher scores are better, but note that the SEO scores on Netlify URLs are artifically constrained to 0.92.

Transfer Size

Category Latest Main Branch
Total 250.645 kB 236.448 kB 236.428 kB 🏆
Scripts 60.635 kB 54.035 kB 54.016 kB 🏆
Stylesheet 54.122 kB 47.858 kB 47.816 kB 🏆
Document 6.229 kB 5.478 kB 🏆 5.514 kB
Font 126.833 kB 126.645 kB 126.606 kB 🏆

Request Count

Category Latest Main Branch
Total 52 52 52
Scripts 41 41 41
Stylesheet 5 5 5
Document 1 1 1
Font 2 2 2

packages/calendar/README.md Outdated Show resolved Hide resolved
packages/calendar/src/Calendar.ts Show resolved Hide resolved
@mizgaionutalexandru mizgaionutalexandru merged commit ba424e0 into feature/date-time-picker Dec 24, 2024
13 of 23 checks passed
@mizgaionutalexandru mizgaionutalexandru deleted the imizga/dtp-docs branch December 24, 2024 08:10
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