Implement changes to formkit README doc structure #203
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Reviewer's Guide by SourceryThis PR implements changes to the formkit README doc structure by updating the paths for the template files used to generate the documentation. It also updates the component names and installation instructions to reflect the new monorepo structure. Class diagram showing the updated package structureclassDiagram
class AuroFormkit {
+version: string
+monorepoName: string
}
AuroFormkit --> Checkbox
AuroFormkit --> Combobox
AuroFormkit --> Counter
AuroFormkit --> Datepicker
AuroFormkit --> Dropdown
AuroFormkit --> Form
AuroFormkit --> Input
AuroFormkit --> Menu
AuroFormkit --> Radio
AuroFormkit --> Select
class Combobox {
+dependencies: [Dropdown, Input, Menu]
}
class Datepicker {
+dependencies: [Dropdown, Input, Popover]
}
class Select {
+dependencies: [Dropdown, Menu]
}
note for AuroFormkit "Package renamed from @auro-formkit to @aurodesignsystem"
File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
There was a problem hiding this comment.
Hey @jordanjones243 - I've reviewed your changes - here's some feedback:
Overall Comments:
- Consider adding migration documentation to help users transition from @auro-formkit/* packages to the new @aurodesignsystem/auro-formkit/* package structure.
Here's what I looked at during the review
- 🟡 General issues: 3 issues found
- 🟢 Security: all looks good
- 🟢 Testing: all looks good
- 🟡 Complexity: 1 issue found
- 🟢 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.
jordanjones243
force-pushed
the
jjones/readMeAndDocs
branch
2 times, most recently
from
55e8a8a to
3421dfe
Compare
jordanjones243
force-pushed
the
jjones/readMeAndDocs
branch
from
3421dfe to
cad9ef2
Compare
rmenner
reviewed
Jan 13, 2025
rmenner
requested changes
Jan 13, 2025
jordanjones243
force-pushed
the
jjones/readMeAndDocs
branch
from
cad9ef2 to
c8d4146
Compare
rmenner
approved these changes
Jan 14, 2025
jordanjones243
force-pushed
the
jjones/readMeAndDocs
branch
from
c8d4146 to
cd906ca
Compare
|
🎉 This PR is included in version 2.0.0-beta.6 🎉 The release is available on: Your semantic-release bot 📦🚀 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Alaska Airlines Pull Request
Before Submitting this pull request:
Developmentsectionnote: all pull requests require at least one linked ticket
Ready For Review, all ticket's linked underDevelopmentmust have their status changed toReady For Reviewas 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
Update README files for all components to use a shared template and remove outdated content.
Enhancements:
Documentation: