Skip to content

docs: make external email signer examples discoverable (development) - #145

Merged
vitormattos merged 2 commits into
mainfrom
docs/external-email-examples-main-20261110
Nov 11, 2026
Merged

vitormattos merged 2 commits into
mainfrom
docs/external-email-examples-main-20261110

Conversation

@vitormattos

Copy link
Copy Markdown
Member

Scope

Make the existing runnable Bash/PHP external-signer examples accessible from the LibreSign development developer guide, with direct links to the clients and matching version-specific fixture. Explain checkout, prerequisites, App Password configuration, one-client-only creation/invitation, status and validation, and authorized WebDAV retrieval. Use bash flow.sh because the file is not executable in Git.

API and release parity

Reviewed against LibreSign application commit corresponding to this documentation line (main); the request-main.json fixture uses the expected required identity field. Keep main and stable13/14/15 documentation independent. Existing clients, fixtures, integration APIs and permissions are unchanged.

Checks and evidence

  • Reviewed version-specific request fields and operations in the application's OpenAPI (create, notification, list, validation); no fixture field mismatch found.
  • Changes limited to developer_manual/api/external-email-signers.rst.
  • Signed commit (GPG verified and DCO): b377149.
  • Sphinx, link checks, full multiversion build, published preview and live disposable Nextcloud signing not yet verified; track CI results separately. The documented flow must be exercised on a disposable test instance with an isolated inbox; successful email delivery, signer completion and PDF certificate trust cannot be inferred from the OpenAPI alone.

Explicit exclusions

No changes to webhook catalog, version indices (main/index.rst), release fixtures, APIs, or PRs #142–#144. No automatic merge.

Review focus: documentation link targets, secure netrc/App Password instructions, and clarity of authorized WebDAV retrieval.

Signed-off-by: Vitor Mattos <1079143+vitormattos@users.noreply.github.com>
Signed-off-by: Vitor Mattos <1079143+vitormattos@users.noreply.github.com>
@github-actions

Copy link
Copy Markdown
Contributor
PR Preview Action v1.8.1-4-g2a6da11

QR code for preview link

🚀 View preview at
https://libresign.github.io/site-preview/docs-preview/pr-145/

Built to branch gh-pages at 2026-11-11 01:48 UTC.
Preview will be ready when the GitHub Pages deployment is complete.

Documentation: All versions · LibreSign 16 development manual · Review notes

Preview is separate from production. LibreSign 16 has not been released; the development manual describes the upcoming version.

@vitormattos
vitormattos merged commit 8e32532 into main Nov 11, 2026
3 checks passed
@vitormattos
vitormattos deleted the docs/external-email-examples-main-20261110 branch November 11, 2026 02:00
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.

1 participant