-
Notifications
You must be signed in to change notification settings - Fork 11
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
Fix index examples #274
Conversation
Reviewer's Guide by SourceryThis 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 updateclassDiagram
class AuroButton {
+register()
+register(name: String)
}
note for AuroButton "Added a new registration method for custom button names"
File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
Surge demo deployment failed! 😭 |
There was a problem hiding this 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
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
ba07de6
to
ca34000
Compare
ca74499
to
0a92c76
Compare
0a92c76
to
d693c51
Compare
🎉 This PR is included in version 8.1.3 🎉 The release is available on: Your semantic-release bot 📦🚀 |
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.
Checklist:
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:
Enhancements:
Build: