Skip to content

Add warning for source code download producing different folder path#392

Open
ishaan119 wants to merge 1 commit into
awslabs:mainfrom
ishaan119:fix/readme-source-zip-folder-path-warning
Open

Add warning for source code download producing different folder path#392
ishaan119 wants to merge 1 commit into
awslabs:mainfrom
ishaan119:fix/readme-source-zip-folder-path-warning

Conversation

@ishaan119

Copy link
Copy Markdown

Add warning for source code download producing different folder path

Some users have git blocked in their environment, making the GitHub
"Code → Download ZIP" button their only option. This produces an
aidlc-workflows-main/ folder instead of the expected aidlc-rules/,
causing setup commands to fail. Added a callout with the rename fix.

Summary

Adds a WARNING callout in the README Common section to help users who download the source code zip instead of the release asset. Includes inline
rename commands for both macOS/Linux and Windows so users can quickly fix the folder path and continue with setup.

Changes

  • Added a > [!WARNING] block after step 3 in the Common section of README.md
  • Includes mv (macOS/Linux) and Move-Item (Windows PowerShell) commands inline to rename the extracted folder

User experience

Before: Users who download via "Code → Download ZIP" get aidlc-workflows-main/aidlc-rules/ but the setup commands reference
~/Downloads/aidlc-rules/. Commands silently fail or produce confusing "no such file" errors with no guidance on how to fix it.

After: A visible WARNING callout immediately tells users what went wrong and gives them a one-liner to fix the path before proceeding.

Checklist

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

Test Plan

  • Verify the [!WARNING] callout renders correctly in GitHub markdown preview
  • Confirm the mv and Move-Item commands work on a fresh source zip download
  • Check that no existing README formatting or links are broken

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
.

Add warning for source code download producing different folder path

  Some users have git blocked in their environment, making the GitHub
  "Code → Download ZIP" button their only option. This produces an
  aidlc-workflows-main/ folder instead of the expected aidlc-rules/,
  causing setup commands to fail. Added a callout with the rename fix.
@github-actions github-actions Bot added the documentation Improvements or additions to documentation label Jun 18, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant