-
Notifications
You must be signed in to change notification settings - Fork 0
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
temporary fix for README.md to have the correct npm path #127
Conversation
Reviewer's Guide by SourceryThis PR updates the README.md file to correct the npm installation path and badge URLs for the auro-formkit package. It also includes changes to the build configuration in package.json files to streamline the documentation build process. Class diagram for package.json script changesclassDiagram
class PackageJson {
- build:docs:kit: "turbo run --filter=@auro-formkit/build-tools build:docs:kit"
+ build:docs:kit: "node ./packages/build-tools/src/kitDocProcessor.mjs"
}
note for PackageJson "Updated the build:docs:kit script to use a direct node command instead of turbo run."
File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
a1800c5
to
ff44d19
Compare
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 @sun-mota - I've reviewed your changes - here's some feedback:
Overall Comments:
- Consider updating the PR title to remove 'temporary' since these appear to be permanent fixes to the package paths and documentation
Here's what I looked at during the review
- 🟢 General issues: all looks good
- 🟢 Security: all looks good
- 🟢 Testing: all looks good
- 🟢 Complexity: all looks good
- 🟢 Documentation: all looks good
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
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.
Looks great!
🎉 This PR is included in version 1.6.0-beta.5 🎉 The release is available on: Your semantic-release bot 📦🚀 |
Alaska Airlines Pull Request
Before Submitting this pull request:
Development
sectionnote: all pull requests require at least one linked ticket
Ready For Review
, all ticket's linked underDevelopment
must have their status changed toReady For Review
as wellBy submitting this Pull Request, I confirm that my contribution is made under the terms of the Apache 2.0 license and I have performed a self-review of my own update.
Summary by Sourcery
Fix the npm package path in the README.md and update the build:docs:kit script for direct execution of kitDocProcessor.mjs.
Enhancements:
Documentation: