Repository navigation
docs: clarify request paths and offline test setup - #53
Closed
Hou (SciencePotato) wants to merge 5 commits into
Closed
Hou (SciencePotato) wants to merge 5 commits into
Hou (SciencePotato) wants to merge 5 commits into
Conversation
Replace architecture illustrations with original editable diagrams that separate evaluation, acceptance, delivery, and regional readiness. Add CI-aligned offline test commands and link them from the runtime guides. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Copilot-Session: eb941502-3065-4ec4-abf8-b5dac1f42ab2
Keep the general BYOT guide instructions-only, link to runtime-specific offline test commands, and draw readiness probes above regional panels. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Copilot-Session: eb941502-3065-4ec4-abf8-b5dac1f42ab2
Add original roadmap, UML request sequence, certificate reuse identifier map, and monitoring evidence illustrations with accessible captions and scalable sources. Keep them in the existing customer guides without runtime or infrastructure changes. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Copilot-Session: eb941502-3065-4ec4-abf8-b5dac1f42ab2
Restore original architecture images unchanged, remove redundant roadmap/monitoring/architecture redraws, and retain the distinct UML and certificate maps. Clarify schematic captions, error-path scope, and certificate reuse inputs and setting. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Copilot-Session: eb941502-3065-4ec4-abf8-b5dac1f42ab2
Extend the UML through the user's app, phone delivery, code entry and access checks. Add verified official Function settings and certificate-version screenshots with exact resource/field guidance and source/license attribution, replacing the abstract certificate map. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Copilot-Session: eb941502-3065-4ec4-abf8-b5dac1f42ab2
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.
Summary
Review scope
Reviewed all 16 tracked Markdown guides: the root README and technical reference; onboarding, BYOT, HTTP contract, monitoring, Application Insights, Entra sign-in monitoring, cost estimation, Front Door, and provider fallback; both setup references; and all three runtime READMEs. Also inspected all 16 existing image assets, captions/alt text/navigation, sample settings, launcher prompts and output fields, relevant handlers/provider registration, CI, and packaging source.
The existing procedural guidance already covers the administrator, credential, validation, activation, monitoring, and renewal handoffs. Changes address concrete visual ambiguities and the missing executable local-test starting point, rather than another broad rewrite. The final refinement preserves the original architecture assets and retains only new illustrations with a distinct purpose.
The accuracy review also corrected stale replacement-image captions/links, scoped the UML to a successful SMS example with endpoint error references, and made the certificate reuse action, unattended ID requirements, and
EPP_DECRYPTION_KEY_PEMsetting explicit. The user-facing app and full token exchange are outside this sample; the Function does not verify the user's entered code or grant app access. Voice UX is not assumed to match SMS.Illustrations
The UML is an original, provider-neutral SVG with a PNG rendering and accessible description. It is a concrete example, not a live-run trace or claim that every sign-in uses SMS.
The two new portal screenshots were located in official documentation, visually inspected, and verified against exact public
MicrosoftDocs/azure-docsblobs before inclusion:1067858212cfae5f69de14fe53a3432eb461b052, image blob6031c3b7512f28093a98550d89b68ffae3a913bf.22e0ade52c247e5d306a78dc9e392d901eb9c198, image blob068a21f7dda41bb315f330769b4b9149e0b1a2c9. The pinned public source is used, not the different current Learn rendering.The source revisions'
LICENSEandThirdPartyNotices.mdexplicitly license documentation/other content under CC BY 4.0; the image folders contain no asset-specific exception notices. Adjacent captions link the exact original asset, its instructional context, Microsoft copyright credit, and license. The screenshots are unmodified generic examples, not private tenant exports: Function values stay hidden; the certificate view contains public demo certificate metadata, not a private key. Instructions warn against copying demo names/expired dates, choosing the wrong identifier/current version, exporting keys, or copying generic host settings into FC1. No standalone NOTICE, permission banner, or approval claim is added.The original architecture images are preserved, not replaced or deleted. Their existing schematic labels are not a literal delivery timeline or deployment template; the accompanying guidance states the applicable limits. The UML supplies the request ordering separately instead of adding another architecture overview.
Validation and limits
git diff --checkpasses.Base reviewed:
ce68ee2649d8e4ab64e00c4abece33e939cdfa9con upstreammain.