jason-capsule42 commented 2 weeks ago

Alaska Airlines Pull Request

Type of change:

Please delete options that are not relevant.

[ ] New capability
[x] Revision of an existing capability
[ ] Infrastructure change (automation, etc.)
[ ] Other (please elaborate)

Checklist:

[x] My update follows the CONTRIBUTING guidelines of this project
[x] I have performed a self-review of my own update

By submitting this Pull Request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

Pull Requests will be evaluated by their quality of update and whether it is consistent with the goals and values of this project. Any submission is to be considered a conversation between the submitter and the maintainers of this project and may require changes to your submission.

Thank you for your submission!
-- Auro Design System Team

Summary by Sourcery

Add missing theme documentation to the API documentation, providing guidance on how to restyle components using design tokens.

Documentation:

Add documentation for theme support, including a code sample for restyling components using design tokens.

sourcery-ai[bot] commented 2 weeks ago

Reviewer's Guide by Sourcery

This pull request adds missing theme documentation to the auro-alert component. It includes a new section in the API documentation that explains how to customize the component's appearance using SCSS variables.

Class diagram for SCSS Variables in auro-alert component

classDiagram
    class AuroAlert {
        --ds-auro-alert-border-color
        --ds-auro-alert-container-color
        --ds-auro-alert-icon-color
        --ds-auro-alert-text-color
    }
    AuroAlert : var(--ds-color-border-secondary-default)
    AuroAlert : var(--ds-color-container-primary-default)
    AuroAlert : var(--ds-color-text-primary-default)

File-Level Changes

Change	Details	Files
Added theme support documentation	Introduced a new 'Theme Support' section in the API documentation Added a code sample demonstrating how to use SCSS variables for customization Included explanations for customizable properties such as border color, container color, icon color, and text color	`demo/api.md` `docs/partials/api.md`

Tips and commands

#### Interacting with Sourcery - **Trigger a new review:** Comment `@sourcery-ai review` on the pull request. - **Continue discussions:** Reply directly to Sourcery's review comments. - **Generate a GitHub issue from a review comment:** Ask Sourcery to create an issue from a review comment by replying to it. - **Generate a pull request title:** Write `@sourcery-ai` anywhere in the pull request title to generate a title at any time. - **Generate a pull request summary:** Write `@sourcery-ai summary` anywhere in the pull request body to generate a PR summary at any time. You can also use this command to specify where the summary should be inserted. #### Customizing Your Experience Access your [dashboard](https://app.sourcery.ai) to: - Enable or disable review features such as the Sourcery-generated pull request summary, the reviewer's guide, and others. - Change the review language. - Add, remove or edit custom review instructions. - Adjust other review settings. #### Getting Help - [Contact our support team](mailto:support@sourcery.ai) for questions or feedback. - Visit our [documentation](https://docs.sourcery.ai) for detailed guides and information. - Keep in touch with the Sourcery team by following us on [X/Twitter](https://x.com/SourceryAI), [LinkedIn](https://www.linkedin.com/company/sourcery-ai/) or [GitHub](https://github.com/sourcery-ai).

blackfalcon commented 2 weeks ago

:tada: This PR is included in version 3.0.1 :tada:

The release is available on:

Your semantic-release bot :package::rocket:

AlaskaAirlines / auro-alert

perf: add missing theme docs #66