docs(10): trim + rewrite scenario 10 README in plain English#36
Open
nzthiago wants to merge 2 commits into
Open
docs(10): trim + rewrite scenario 10 README in plain English#36nzthiago wants to merge 2 commits into
nzthiago wants to merge 2 commits into
Conversation
Matches the scenario 11 README style: hero sentence, deploy/test up top (was at line 109), then Clean up, then a single compact 'How it works' ASCII flow + a single compact 'Security model' section. 'Going further' rolls up the previous Production tips + Known limitations + What it composes sections into 3 bullets + a preview caveat. Drops: - mermaid sequence diagram (replaced with simpler ASCII flow that also reads in raw view) - 'What this ships' file tree (the Bicep modules speak for themselves) - 'Where the gateway API key lives' truth table (subsumed by the security-model table + the 'sandbox holds no MCP credential' line) - separate Prerequisites section (now a one-liner at the top of Deploy/test) - 'Local-dev quickstart' standalone section (the python/ runner remains in the tree but the README doesn't need a section for it) - 'What it composes' cross-link list (the security model + ASCII flow tell the same story) Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Same treatment scenario 11 got in Azure-Samples#43. The previous opening read like marketing copy: > A new Outlook email fires an Azure Connector Gateway trigger -> > the gateway POSTs to an ACA receiver -> the receiver boots a > fresh sandbox per email -> GitHub Copilot CLI in the sandbox > classifies the email and posts a triage card to a Teams > channel... Rewritten to lead with what the scenario actually does: > A new email arrives in your Outlook inbox. This sample looks at > each one, decides whether it actually matters (a paged incident, > an urgent customer request, that kind of thing), and if it > does, posts a short triage card into your Teams channel with > the sender, the subject, and one sentence on why it matters. > > How it works in one paragraph... Other changes: - All em dashes removed. - Section intros rewritten as prose. - Removed the 'The reference Functions sample uses this pattern - same shape applies here' line (don't cast shade or anchor to other products). - 'Going further' bullets rewritten as plain sentences, no em-dash-separated snippets. No structural changes. Same sections, same diagram, same tables. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
nzthiago
changed the title
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
1 participant
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.
docs(10): trim scenario 10 README — 240 → 119 lines
Same treatment we just applied to scenario 11 in #33: bring the
quickstart up to the top, drop sections that duplicate context the
diagram or security-model table already convey.
Kept:
azd upblock, log-tail snippet)Dropped:
security-model table + the 'sandbox holds no MCP credential' line)
python/runner still in tree)Net: 94 insertions, 215 deletions.