docs(debug-logger): maker guide (#17)#38
Merged
Conversation
The single largest doc in the POC. Restructured per v5 plan §6 for adoption flow: - Quick Start (≈20 min per D9/A13) with copy-pasteable sample JSON - Common Setup with A15 payload truncation note - Pattern A — Wrap ExecuteAgentAndWait in PA flow (with scope callout for Direct Line / Teams; A8 cr_sequence per-caller warning; D4 end-user-utterance trigger warning) - Pattern B — Wrap a tool flow (same warnings) - Pattern C — CoT topic (cost callout; D6 variant chooser; D3 cross-pattern correlation warning; A16 managed-agent caveat; A14 infinite-loop kill switch 3-step recovery) - Pattern D — ConvHistory topic (D6 variant chooser; 3 downstream extension points: ticket / escalation / MCP-Outlook) - Pattern E (optional) — End-to-end correlation across CS + PA (B4 softened correlation claim; explicit fallback chain) Closes #17 Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
judeper
force-pushed
the
squad/17-docs-maker-guide
branch
from
fc35377 to
9f40392
Compare
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.
Closes #17
What
copilot-agent-debug-logger/docs/maker-guide.md— Quick Start + Common Setup + Patterns A-E.v5 plan reference
§6 Maker integration patterns
Acceptance (from #17)
All 5 patterns + Quick Start + Common Setup. Each pattern carries the required warnings/callouts (cr_sequence per-caller, payload truncation, cost callout, variant chooser, correlation warning, managed-agent caveat, kill switch, softened correlation claim, fallback chain).
Validation
text Line count: 687 (target 500-900) Quick Start True Pattern A True Pattern B True Pattern C True Pattern D True Pattern E True cr_sequence True A8|per-caller True A15|truncat True D6|variant chooser|Choose your variant True A14|kill.?switch True A16|managed.?solution True B4|softened|within a single conversation True System.Conversation.Id True log-chain-of-thoughts True save-conversation-history True Power CAT True ExecuteAgentAndWait True 20 min TrueNote
docs/deployment-guide.md was not present on origin/main or an origin/squad/16-docs-deployment branch while authoring; the maker guide keeps the requested references for the sibling doc.