Skip to content

docs: add workshop release download notice to README #142

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
Kalindi-Dev wants to merge 1 commit into from
+3 −0
Closed

docs: add workshop release download notice to README #142

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,9 @@ AI-DLC is an intelligent software development workflow that adapts to your needs

---

> [!NOTE]
> **For workshops, we recommend using a pinned release version.** The current recommended release is [v0.1.6](https://github.com/awslabs/aidlc-workflows/releases/tag/v0.1.6). The `main` branch contains ongoing development changes that may not yet be included in a release.
Copy link
Copy Markdown
Contributor

@raj-jain-aws raj-jain-aws Mar 25, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The README Quick Start section already guides the user to download the zip https://github.com/awslabs/aidlc-workflows?tab=readme-ov-file#quick-start and not clone the repo so this addition seems redundant.

Further, the notion of a workshop in the project's README seems a bit misplaced. I think it confuses an ordinary consumer of this repo what a workshop means. Suggest that the person coordinating an AI-DLC workshop reinforce such an instruction with participants offline.


## Quick Start

1. Download the latest release zip from the [Releases page](../../releases/latest) to a folder **outside** your project directory (e.g., `~/Downloads`).
Expand Down