Skip to content

docs(repos/postguard-outlook-addon): refresh page after v1 rewrite - #45

Merged
rubenhensen merged 1 commit into
mainfrom
docs/outlook-addon-v1-refresh
May 5, 2026
Merged

docs(repos/postguard-outlook-addon): refresh page after v1 rewrite#45
rubenhensen merged 1 commit into
mainfrom
docs/outlook-addon-v1-refresh

Conversation

@dobby-coder

@dobby-coder dobby-coder Bot commented May 5, 2026

Copy link
Copy Markdown
Contributor

Closes #43.

Refreshes docs/repos/postguard-outlook-addon.md to match the v1 rewrite merged in encryption4all/postguard-outlook-addon#16 (merge commit f602030dafe2f958dabf7bacbf6239c8c65e291b).

Changes

  • Architecture bullets now describe the actual src/ layout: taskpane/{taskpane,read-view,compose-view,policy-editor}.ts, yivi-dialog/yivi-dialog.{ts,html}, launchevent/launchevent.ts, and the lib/ helpers (office-helpers, mime, graph-client, pkg-client, auth, i18n, encoding, attributes, storage, types, dialog-chunk).
  • Drop the stale commands.ts dialog snippet (commands.ts is now a 10-line FunctionFile shim). Replace with two snippets pulled from launchevent.ts at the merge commit: the displayDialogAsync call and the chunked messageChild dispatch loop.
  • Document the split between the inline taskpane Yivi flow (#yivi-web-form mounted in the taskpane DOM) and the dialog Yivi flow used during OnMessageSend.
  • Add a Known quirks section pointing at the new in-repo docs/outlook-quirks.md.
  • Rewrite Releasing: release-please plus GHCR (:edge for staging, version tag for production), built and pushed by .github/workflows/release.yml. NGINX-based image, deploy still requires pulling the new tag on the host.
  • Add the new package.json scripts (start, stop, validate).

Verification

  • All snippets pulled from raw GitHub at merge commit f602030; line ranges verified to match the file.
  • npx vitepress build docs succeeds locally.
  • Checked the prose for the banned-words and em-dash rules in CLAUDE.md. The only is inside a code snippet (an arrow character in a log message, not an em dash).

Reviewer quickstart

git fetch origin && git checkout docs/outlook-addon-v1-refresh && npm install && npm run docs:dev

Aligns the Outlook add-in docs with the v1 rewrite merged in
encryption4all/postguard-outlook-addon#16 (merge commit f602030).

- Architecture bullets now cover the new src/ layout (taskpane,
  yivi-dialog, launchevent, lib/* helpers).
- Replace the obsolete commands.ts dialog snippet with two snippets
  pulled from launchevent.ts at the merge commit, covering
  displayDialogAsync and the chunked messageChild dispatch loop.
- Note the inline taskpane Yivi flow vs. the dialog flow used during
  OnMessageSend.
- Link to the new in-repo docs/outlook-quirks.md.
- Rewrite the Releasing section around release-please plus the GHCR
  image (:edge for staging, version tag for production).
- Add the new package.json scripts (start, stop, validate).

Closes #43
@rubenhensen
rubenhensen merged commit 50922fd into main May 5, 2026
1 check passed
@rubenhensen
rubenhensen deleted the docs/outlook-addon-v1-refresh branch May 5, 2026 14:51
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.

docs(repos/postguard-outlook-addon): refresh page after v1 rewrite

1 participant