Skip to content

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

Description

@dobby-coder

The docs/repos/postguard-outlook-addon.md page references the pre-rewrite layout. encryption4all/postguard-outlook-addon#16 (Feature/v1 rewrite, merged 2026-05-04) restructured the addon substantially. The current docs page no longer matches reality.

Concrete drift

  1. Architecture bullets (L13-L20):

    • "Compose pane: encryption toggle and policy editor" — the standalone src/compose/ folder was deleted. Compose UI now lives in src/taskpane/compose-view.ts and src/taskpane/policy-editor.ts.
    • "Dialog: Office.context.ui.displayDialogAsync() opens Yivi popup" — src/dialog/ was deleted; the new dialog lives in src/yivi-dialog/yivi-dialog.{ts,html} and chunked-message bridging is in src/lib/dialog-chunk.ts.
    • The compose/decrypt logic was rewritten on top of new helpers: src/lib/office-helpers.ts, src/lib/mime.ts, src/lib/graph-client.ts, src/lib/pkg-client.ts, src/lib/auth.ts, src/lib/i18n.ts, src/lib/encoding.ts, src/lib/attributes.ts, src/lib/storage.ts, src/lib/types.ts. Worth a brief mention.
  2. Yivi Dialog code snippet (L26-L70): pulled from src/commands/commands.ts at commit dd0073b. After PR Add link to postguard.eu #16, commands.ts shrank by 377 lines and the dialog is opened from src/yivi-dialog/yivi-dialog.ts. The snippet's referenced dialog.html no longer exists — it is now yivi-dialog.html. Re-pull the snippet from commands.ts or yivi-dialog.ts at the merge commit.

  3. Releasing section (L105-L111): says "This add-in does not currently have automated releases." PR Link towards Postguard #15 added .github/workflows/release.yml (release-please + Docker build), and PR Add link to postguard.eu #16 commits Dockerfile, nginx/default.conf, .dockerignore, and release-please-config.json. The releasing section needs a rewrite around release-please + the published Docker image.

  4. Development section (L74-L96): scripts in package.json changed (10 additions, 20 deletions in PR Add link to postguard.eu #16). Verify npm run dev-server / npm run build / etc. still match the new package.json script names.

  5. New in-repo docs file: PR Add link to postguard.eu #16 added docs/outlook-quirks.md (302 lines) covering Outlook quirks worth surfacing to users. Consider a link from the postguard-docs page or pulling key items into a "Known quirks" section.

Source PR

Verification

  • Pull all snippets from the new merge commit, not dd0073b.
  • npx vitepress build docs must succeed.
  • Watch the banned-words list in CLAUDE.md; no em dashes.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions