fix: Minor updates to README#192
Merged
raj-jain-aws merged 3 commits intomainfrom Apr 20, 2026
Merged
Conversation
raj-jain-aws
requested review from
a team,
harmjeff,
scoropeza,
scottschreckengaust and
spraja08
github-actions
Bot
added
the
documentation
leandrodamascena
requested changes
Apr 19, 2026
Contributor
leandrodamascena
left a comment
leandrodamascena
left a comment
There was a problem hiding this comment.
Hey @raj-jain-aws, thanks for the cleanup. I created #193 for traceability on this change.
I just left 2 comments and see if that make sense. Other than that, LGTM! The content is the same, you just reorganized.
Co-authored-by: Leandro Damascena <lcdama@amazon.pt>
Fixed header syntax
Contributor
Author
Thanks @leandrodamascena for comments and opening an issue to capture this. Addressed both comments. Pls. review. |
leandrodamascena
approved these changes
Apr 19, 2026
Contributor
There was a problem hiding this comment.
Thanks for addressing the feedback @raj-jain-aws. Approved.
spraja08
approved these changes
Apr 20, 2026
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Summary
Closes #193
Minor updates to README
Changes
Moved the "Experimental: AI-Assisted Setup" section lower in the document (after "Generated aidlc-docs/ Reference"), since it's supplementary content rather than a primary setup path. The installation prompt takes up 3% of context window before AI-DLC workflow even starts. Also, the instructions are written for *nix systems and not for Windows CMD and Windows Powershell.
Fixed ToC to match the new section order
Added missing "Generated aidlc-docs/ Reference" and "Contributing" entries to the ToC
Removed stale "Security" heading and replaced it with "Contributing" to match the section's actual content
Fixed -- → --- horizontal rule for proper markdown rendering
Added a note in
CONTRIBUTING.mdto test installation instructions on Mac, Windows CMD, and Windows PowerShellUser experience
Reverted installation sequence as before in terms of user experience
Checklist
If your change doesn't seem to apply, please leave them unchecked.
Test Plan
N/A
Acknowledgment
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of the project license.