Skip to content

Update README.md#260

Open
mrritesh14 wants to merge 1 commit into
awslabs:mainfrom
mrritesh14:patch-1
Open

Update README.md#260
mrritesh14 wants to merge 1 commit into
awslabs:mainfrom
mrritesh14:patch-1

Conversation

@mrritesh14
Copy link
Copy Markdown

Set up instructions to run the initial commands copying the aws-aidlc-rules and aws-aidlc-rule-details folders from the extracted zip folder and the user download directory do not reflect correctly with the downloaded zip version extracted folders structure in the user downloads folder. Upon extraction, the folder structure is Downloads>ai-dlc-rules-v0.1.8>aidlc-rules. I committed changes just for the windows command prompt instructions. This created confusion among the customer end users when running the AI-DLC workshops.

Summary

Set up instructions to run the initial commands copying the aws-aidlc-rules and aws-aidlc-rule-details folders from the extracted zip folder and the user download directory do not reflect correctly with the downloaded zip version extracted folders structure in the user downloads folder. Upon extraction, the folder structure is Downloads>ai-dlc-rules-v0.1.8>aidlc-rules. I committed changes just for the windows command prompt instructions. This created confusion among the customer end users when running the AI-DLC workshops.

Changes

Update the copy commands in alignment with the extracted zip folder or add instructions for the end-users to adjust the copy commands with the folder structure of zip file in the user Downloads folder

User experience

Before this change, while running AI-DLC workshops, customers get confused in running the copy commands. After this change, end users should have more clarity to adjust the command.

Checklist

If your change doesn't seem to apply, please leave them unchecked.

  • I have reviewed the contributing guidelines
  • I have performed a self-review of this change
  • Changes have been tested
  • Changes are documented

Test Plan

replace with instructions or a checklist for reviewers to verify

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.

Set up instructions to run the initial commands copying the aws-aidlc-rules and aws-aidlc-rule-details folders from the extracted zip folder and the user download directory do not reflect correctly with the downloaded zip version extracted folders structure in the user downloads folder. Upon extraction, the folder structure is Downloads>ai-dlc-rules-v0.1.8>aidlc-rules. I committed changes just for the windows command prompt instructions. This created confusion among the customer end users when running the AI-DLC workshops.
@github-actions github-actions Bot added the documentation Improvements or additions to documentation label May 12, 2026
@Kalindi-Dev
Copy link
Copy Markdown
Contributor

@mrritesh14 The v0.1.8 is the latest release versions. Release versions are subject to change and therefore can't be hardcoded in the file.
The structure that you highlighted Downloads>ai-dlc-rules-version>aidlc-rules will keep changing as we have new versions coming in the file and we can't have versions hardcoded in files.
Another fix would be would to flag ai-dlc-rules-version in the file, but again the customers would still need to substitute "version" with the actual version.

@mrritesh14
Copy link
Copy Markdown
Author

@Kalindi-Dev Yes. Agreed !! This situation is creating confusion among the customers during the workshop kick-off. It is better to add the instructions in the platform setup. Currently, platform setup instructions and extracted zip folder structure is not aligned. I agreed with the second alternate fix " flag ai-dlc-rules-version in the file, but again the customers would still need to substitute "version" with the actual version". Instructions should be added for the customer to replace the version in the extracted files because it fixes the extracted zip file folders structure after downloading it in the user's DOWNLOADS folder.

@harmjeff
Copy link
Copy Markdown
Contributor

Please fix the title per the instructions in the CONTRIBUTING.md instructions

@scottschreckengaust scottschreckengaust added wontfix This will not be worked on do-not-merge Halts a pull request from merging labels May 14, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

do-not-merge Halts a pull request from merging documentation Improvements or additions to documentation wontfix This will not be worked on

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants