Add aidlc-docs/ Reference Documentation#2
Merged
harmjeff merged 2 commits intoharmjeff:mainfrom Mar 20, 2026
Merged
Conversation
added 2 commits
March 18, 2026 14:12
Add a new 'Generated aidlc-docs/ Reference' section showing the complete directory tree of all possible files created during an AI-DLC workflow run. Each file is annotated with its purpose and the conditions under which it is generated (brownfield-only, conditional stages, per-unit, etc.). Cross-referenced against real regression run outputs to validate accuracy and added notes covering single-unit simplification patterns observed in practice (e.g. simplified plan naming, variable build-and-test file sets).
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
2 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.
What
Adds a complete reference of every file the AI-DLC workflow can generate inside aidlc-docs/, its own doc to keep the README lean.
Why
Users had no single place to understand the full set of artifacts produced by an AI-DLC run. The directory tree, conditional file annotations, and notes on single-unit simplification patterns give a clear picture of what to expect. Keeping it in a dedicated file avoids bloating the README while still being one click away.
Commits
7a1a437 — adds the "Generated aidlc-docs/ Reference" section to the README with the fully populated directory tree, per-file annotations, and usage notes. Validated against real regression run outputs.
32af498 — extracts that section into
GENERATED_DOCS_REFERENCE.md
and replaces it in the README with a link. Table of Contents anchor preserved.
Changes
README.md — new ToC entry and a link pointing to the reference doc.
GENERATED_DOCS_REFERENCE.md
— new file with the complete aidlc-docs directory tree and notes.