[WIP] Update example READMEs for AI output files and diagram explanation#50
Draft
[WIP] Update example READMEs for AI output files and diagram explanation#50
Conversation
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.
ai/examples/01_peered_vnets/README.md:ai/examples/02_distributed_app/README.md:Original prompt
Goal
Update the two example READMEs under
ai/examples/so that each one:Explicitly produces two output files as part of the worked example:
.tfvarsfile (already exists asoutput.tfvars)README.md(the example README itself, which should be described as also being an AI-generated output)Showcases the original diagram image prominently, with the
embed near the top.Explains in detail how the diagram was interpreted — what the AI saw, what decisions it made, what it guessed vs. asked about, and how the relational model shaped the output.
Files to Update
ai/examples/01_peered_vnets/README.mdCurrent BlobSha:
29a70d542149c34077847681f10f00499fc5fe03This README is already well-structured but needs the following changes:
Add a preamble section at the top (after the title, before "The Diagram") that describes both output files generated from the diagram:
app01.tfvars— the TFVARS fileREADME.md— this document, which is itself a generated artifact explaining the AI's interpretationKeep the diagram embed (
) prominent.Expand "What I Saw" to include a more detailed visual walkthrough — describe what specific marks, labels, boxes, and arrows are visible in the image and what they mean.
Expand "How I Translated It" to include a subsection called
### Step 5: The Two Outputsthat explains:app01.tfvarscontaining the infrastructure declaration with# REVIEW:and# EXPLAINcommentsUpdate the output reference to point to
app01.tfvars(which it already does) and make clear that the README is the second output.In "What I Learned", add a 5th lesson about generating the README as a second output artifact.
ai/examples/02_distributed_app/README.mdCurrent BlobSha:
2243fb7b6539afc1304a9b9274bb051b5fcec75fSame pattern of changes:
Add a preamble section describing both output files:
az_app.tfvars— the TFVARS fileREADME.md— this document, the AI's interpretation narrativeKeep the diagram embed prominent.
Expand "What I Saw" with more visual detail about what specifically appears in the image.
Expand "How I Translated It" with a
### Step 5: The Two Outputssection explaining the dual-output nature.In "What I Learned", add a lesson about the README as a second output.
Tone and Style
Context
The existing file contents are as follows:
ai/examples/01_peered_vnets/README.md(current):ai/examples/02_distributed_app/README.md(current):The full current content of both READMEs and both
.tfvarsfiles is available in the repository at the paths above.Summary of Changes Required
For EACH of the two example READMEs:
This pull request was created from Copilot chat.