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 index examples #274

Merged
merged 4 commits into from
Nov 5, 2024
Merged

Fix index examples #274

merged 4 commits into from
Nov 5, 2024

Conversation

jordanjones243
Copy link
Contributor

@jordanjones243 jordanjones243 commented Nov 5, 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: #273

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

Fix index examples by properly registering AuroButton and enhance API documentation with 'back to top' links. Update development dependencies in package.json to their latest versions and adjust rollup configuration to include nodeResolve plugin.

Bug Fixes:

  • Correct index examples in the demo by registering AuroButton properly.

Enhancements:

  • Add 'back to top' links to the API documentation for improved navigation.

Build:

  • Update several development dependencies in package.json to their latest versions.

@jordanjones243 jordanjones243 self-assigned this Nov 5, 2024
@jordanjones243 jordanjones243 requested a review from a team as a code owner November 5, 2024 20:34
Copy link

sourcery-ai bot commented Nov 5, 2024

Reviewer's Guide by Sourcery

This PR updates the API documentation formatting and fixes example configurations. The changes include adding 'back to top' links in the API documentation, updating dependencies, and fixing the rollup configuration for example files. The PR also includes a minor modification to the button registration in the demo index file.

Class diagram for AuroButton registration update

classDiagram
    class AuroButton {
        +register()
        +register(name: String)
    }
    note for AuroButton "Added a new registration method for custom button names"
Loading

File-Level Changes

Change Details Files
Added 'back to top' navigation links to API documentation
  • Added anchor tags with 'back to top' links for each property, event, and CSS shadow part in the documentation
  • Maintained existing documentation structure while enhancing navigation
demo/api.md
Updated build configuration and dependencies
  • Added nodeResolve plugin to index and API examples rollup configs
  • Updated various dependency versions including eslint, compression, concurrently, and rollup
  • Updated @aurodesignsystem/eslint-config from 1.3.2 to 1.3.3
rollup.config.mjs
package.json
package-lock.json
Modified button registration in demo setup
  • Added explicit AuroButton.register() call before custom button registration
demo/index.js

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

@jordanjones243 jordanjones243 linked an issue Nov 5, 2024 that may be closed by this pull request
Copy link

github-actions bot commented Nov 5, 2024

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 @jordanjones243 - I've reviewed your changes - here's some feedback:

Overall Comments:

  • The 'back to top' links on every table row make the documentation harder to read. Consider adding these links only at major section breaks instead.
  • Please explain why the nodeResolve plugin was added to the rollup configs - what issue does this solve?
Here's what I looked at during the review
  • 🟡 General issues: 1 issue found
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟡 Documentation: 1 issue found

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.js Show resolved Hide resolved
demo/api.md Outdated 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/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
@jordanjones243 jordanjones243 force-pushed the jjones/fixIndexExamples/#273 branch from ba07de6 to ca34000 Compare November 5, 2024 20:47
jason-capsule42
jason-capsule42 previously approved these changes Nov 5, 2024
src/style.scss Outdated Show resolved Hide resolved
src/style.scss Outdated Show resolved Hide resolved
@jordanjones243 jordanjones243 force-pushed the jjones/fixIndexExamples/#273 branch from 0a92c76 to d693c51 Compare November 5, 2024 22:09
@jason-capsule42 jason-capsule42 self-requested a review November 5, 2024 22:20
@jason-capsule42 jason-capsule42 merged commit 50693bd into master Nov 5, 2024
6 of 7 checks passed
@jason-capsule42 jason-capsule42 deleted the jjones/fixIndexExamples/#273 branch November 5, 2024 22:21
@blackfalcon
Copy link
Member

🎉 This PR is included in version 8.1.3 🎉

The release is available on:

Your semantic-release bot 📦🚀

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

Examples on index page not loading
3 participants