Add warning for source code download producing different folder path#392
Open
ishaan119 wants to merge 1 commit into
Open
Add warning for source code download producing different folder path#392ishaan119 wants to merge 1 commit into
ishaan119 wants to merge 1 commit into
Conversation
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.
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
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.
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
> [!WARNING]block after step 3 in the Common section of README.mdmv(macOS/Linux) andMove-Item(Windows PowerShell) commands inline to rename the extracted folderUser 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
Test Plan
[!WARNING]callout renders correctly in GitHub markdown previewmvandMove-Itemcommands work on a fresh source zip downloadAcknowledgment
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of the project
license.