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

Add alaska.md to processed doc files #170 #172

Merged
merged 1 commit into from
Jan 28, 2025

Conversation

rmenner
Copy link
Contributor

@rmenner rmenner commented Jan 28, 2025

Alaska Airlines Pull Request

Type of change:

Please delete options that are not relevant.

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

Checklist:

  • My update follows the CONTRIBUTING guidelines of this project
  • 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 support for alaska.md documentation.

New Features:

  • Introduce the auro-alaska custom element, which provides an easy way to use the official Alaska Airlines logo with automatic scaling and tagline support.

Enhancements:

  • Update the build process to include alaska.md in the processed documentation files.

Documentation:

  • Add documentation for the auro-alaska component.

@rmenner rmenner requested a review from a team as a code owner January 28, 2025 01:24
@rmenner rmenner linked an issue Jan 28, 2025 that may be closed by this pull request
Copy link

sourcery-ai bot commented Jan 28, 2025

Reviewer's Guide by Sourcery

This pull request adds a new documentation file for the auro-alaska component and updates the build process to include it.

Class diagram for auro-alaska component

classDiagram
    class AuroAlaska {
        +boolean official
        +boolean onDark
        +string width
        +render()
    }
    note for AuroAlaska "Auto-scales logo based on container width"
Loading

Flow diagram of updated documentation build process

graph LR
    A[Source Files] --> B[processDocs.mjs]
    B --> C{Process Files}
    C --> D[Default Docs]
    C --> E[alaska.md]
    D --> F[Output Directory]
    E --> F
Loading

File-Level Changes

Change Details Files
Added documentation for the auro-alaska component.
  • Created a new markdown file with documentation for the auro-alaska component.
  • Included examples of the component with and without the official tagline.
  • Demonstrated the auto-scaling feature of the component.
docs/partials/alaska.md
Updated the documentation build process.
  • Modified the build:docs script to use a new processing script.
  • Created a new script to process documentation files, including the new alaska.md file.
  • Added the new documentation file to the list of files to be processed.
package.json
packageScripts/processDocs.mjs

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. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the 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 exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!
  • Generate a plan of action for an issue: Comment @sourcery-ai plan on
    an issue to generate a plan of action for it.

Customizing Your Experience

Access your dashboard 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

@rmenner rmenner self-assigned this Jan 28, 2025
Copy link

Surge demo deployment failed! 😭

Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @rmenner - I've reviewed your changes and they look great!

Here's what I looked at during the review
  • 🟡 General issues: 4 issues found
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

packageScripts/processDocs.mjs Show resolved Hide resolved
packageScripts/processDocs.mjs Show resolved Hide resolved
packageScripts/processDocs.mjs Show resolved Hide resolved
docs/partials/alaska.md Show resolved Hide resolved
@jason-capsule42 jason-capsule42 merged commit b6d2a6d into main Jan 28, 2025
6 of 7 checks passed
@jason-capsule42 jason-capsule42 deleted the rmenner/docs/include-alaska branch January 28, 2025 14:55
@blackfalcon
Copy link
Member

🎉 This PR is included in version 6.1.6 🎉

The release is available on:

Your semantic-release bot 📦🚀

@blackfalcon blackfalcon added the released Completed work has been released label Jan 28, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
released Completed work has been released
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Remove cached .md files
4 participants