Skip to content

docs: add detailed single-region onboarding and separate technical reference - #30

Merged
Hou (SciencePotato) merged 4 commits into
mainfrom
docs/single-region-onboarding
Oct 5, 2026
Merged

Hou (SciencePotato) merged 4 commits into
mainfrom
docs/single-region-onboarding

Conversation

@SciencePotato

@SciencePotato Hou (SciencePotato) commented Oct 5, 2026 •

Copy link
Copy Markdown
Collaborator

Summary

  • Make the main README a detailed, explained single-region onboarding guide with the single-region diagram from page 1 of the supplied architecture PDF.
  • Explain prerequisites and permissions, required inputs, provider/app registration, language selection, deployment approval and outputs, provider authentication, validation, manual activation/rollback, and a completion checklist.
  • Preserve the previous technical README in TECHNICAL.md and update documentation links.
  • Keep multi-region and resiliency guidance out of scope.

Compatibility

  • Rebased onto the latest main, preserving current Key Vault certificate issuance and background credential refresh documentation.
  • Documentation and one diagram only; no application, infrastructure, or pipeline changes.

Validation

  • Verified local Markdown links and heading anchors across all six changed documentation files.
  • Verified TECHNICAL.md retains the latest main README content apart from title/navigation updates.
  • Confirmed the diagram exactly renders page 1 of the user-updated PDF (October 5); no label edits were applied. Only the single-region image is embedded. Visually checked the rendering; the multi-region page is excluded.
  • git diff --check passed. Application tests were not run because this is documentation-only.

Hou Chi Chan and others added 3 commits October 5, 2026 13:57
…ence

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@SciencePotato
Hou (SciencePotato) merged commit 5fc4f0a into main Oct 5, 2026
9 checks passed
@SciencePotato
Hou (SciencePotato) deleted the docs/single-region-onboarding branch October 5, 2026 22:55

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Provider adapter is part of SendOtp api, let's put them into same box

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants