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

fix: update markdown partial pathing to consume new auro lib #48 #49

Merged
merged 2 commits into from
Nov 21, 2024

Conversation

sun-mota
Copy link
Contributor

@sun-mota sun-mota commented Nov 8, 2024

Alaska Airlines Pull Request

Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.

Resolves: #48

Summary:

Please summarize the scope of the changes you have submitted, what the intent of the work is and anything that describes the before/after state of the project.

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

Bug Fixes:

  • Update markdown partial paths to align with the new auro library structure.

Summary by Sourcery

Bug Fixes:

  • Update markdown partial paths to align with the new auro library structure.

Summary by Sourcery

Bug Fixes:

  • Update markdown partial paths to align with the new auro library structure.

Summary by Sourcery

Update markdown partial paths to reflect the new auro library structure and enhance the build process by adding the nodeResolve plugin to the Rollup configuration.

Bug Fixes:

  • Update markdown partial paths to align with the new auro library structure.

Enhancements:

  • Add nodeResolve plugin to Rollup configuration for better module resolution.

@sun-mota sun-mota requested a review from a team as a code owner November 8, 2024 22:16
@sun-mota sun-mota linked an issue Nov 8, 2024 that may be closed by this pull request
Copy link

sourcery-ai bot commented Nov 8, 2024

Reviewer's Guide by Sourcery

This PR updates the file path references in markdown files to align with the new auro library structure. The changes primarily involve modifying relative path references in various markdown and configuration files to use the updated directory structure. Additionally, the PR updates the auro-library dependency to version ^3.0.1 and adds nodeResolve plugin to rollup configurations.

No diagrams generated as the changes look simple and do not need a visual representation.

File-Level Changes

Change Details Files
Updated markdown file path references to align with new directory structure
  • Changed relative path references from './../../' to '../' in multiple files
  • Updated paths from './../' to '../docs/' for better organization
  • Modified content source paths in AURO-GENERATED-CONTENT blocks
demo/api.md
demo/index.md
docs/partials/api.md
docs/partials/index.md
README.md
Updated build configuration and dependencies
  • Added nodeResolve plugin to rollup configurations for both index and api examples
  • Updated @aurodesignsystem/auro-library dependency from ~2.8 to ^3.0.1
  • Updated WC-Generator template reference path in README.md
rollup.config.mjs
package.json
README.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 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

@sun-mota sun-mota self-assigned this Nov 8, 2024
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 @sun-mota - I've reviewed your changes and they look great!

Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟡 Complexity: 1 issue found
  • 🟢 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.

demo/index.min.js Show resolved Hide resolved
demo/api.min.js Show resolved Hide resolved
demo/api.min.js Show resolved Hide resolved
demo/api.min.js Show resolved Hide resolved
demo/api.min.js Show resolved Hide resolved
demo/index.min.js Show resolved Hide resolved
demo/index.min.js Show resolved Hide resolved
demo/index.min.js Show resolved Hide resolved
demo/index.min.js Show resolved Hide resolved
demo/index.min.js Show resolved Hide resolved
@chrisfalaska
Copy link
Contributor

When I pulled the branch locally and ran dev, I noticed icons appeared under "Recommended Use and Version Control":

Image

However, they do not appear on the DocSite:

Image

I just wanted to confirm if this was intentional?

@sun-mota
Copy link
Contributor Author

sun-mota commented Nov 13, 2024

When I pulled the branch locally and ran dev, I noticed icons appeared under "Recommended Use and Version Control":

Image

However, they do not appear on the DocSite:

Image

I just wanted to confirm if this was intentional?

docSite is the one that has a bug ;)

@sun-mota sun-mota merged commit 7eb49af into main Nov 21, 2024
6 checks passed
@sun-mota sun-mota deleted the sunMota/new-build-scripting/48 branch November 21, 2024 18:39
@blackfalcon
Copy link
Member

🎉 This PR is included in version 3.1.2 🎉

The release is available on:

Your semantic-release bot 📦🚀

@blackfalcon blackfalcon added the released Completed work has been released label Nov 21, 2024
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.

auro-loader: update to latest auro-library version
4 participants