Skip to content

docs(site): refresh API guide with official versioned OpenAPI links - #531

Merged
vitormattos merged 3 commits into
mainfrom
docs/refresh-api-guide-official-openapi-20261110
Nov 11, 2026
Merged

vitormattos merged 3 commits into
mainfrom
docs/refresh-api-guide-official-openapi-20261110

Conversation

@vitormattos

@vitormattos vitormattos commented Nov 11, 2026 •

Copy link
Copy Markdown
Member

Purpose

Keep the existing LibreSign API Guide as an editorial entry point to official integration documentation, rather than an alternative API reference.

Changes

  • The editorial change is confined to source/_posts/api-documentation.md. Preserve title: LibreSign API Guide (which determines the URL), Vitor Mattos's authorship, and the original 2024-10-10 publication date.
  • Add updated: 2026-11-10 and a visible update note without changing the original publication date.
  • Replace F12/OCS API Viewer as the primary integration method with a single link to the official documentation home, where readers select their installed LibreSign version and find integration guides, examples and the versioned OpenAPI reference.
  • Explain Nextcloud/OCS authentication, App Passwords, release compatibility, and backend integration with external systems without listing specific release numbers or endpoints.
  • Keep browser inspection and OCS API Viewer as optional debugging aids.
  • Refresh the page description for search/social previews. No additional article, pricing change, template refactor, merge, or production deployment.

Checks and evidence

  • The official documentation and versioned resources were checked during the initial investigation; the updated article links only to the stable documentation entry point at https://docs.libresign.coop/.
  • Verified preservation of the original title, author, publication date and update date; confirmed the revised content contains no hardcoded LibreSign release-number links. SEO description remains unchanged.
  • Synchronized .github/workflows/preview.yml with the already merged preview fix from #534 to trigger a fresh preview run. The workflow file's blob SHA now exactly matches current main; it still appears as an additional file in the three-dot PR diff because the branch predates the fix(ci): avoid waiting for superseded Pages builds #534 merge. No new workflow behavior is proposed here.
  • Commit is cryptographically signed and DCO matches the author.
  • Current SHA 46609eb5e2ad4915f9302915ab666d697a3487ce: 7/7 checks successful, including the preview check and Jigsaw production build. The rendered article preview was opened and verified: updated title/body, official documentation link and version-neutral navigation are present. No production deploy or merge.

Localization

Site translations are maintained through Weblate, not manually in lang/. Verified translation gap: the currently published pt-BR article is translated, but the PR's pt-BR preview falls back to English for the revised article body. The fr version was already falling back to English before this PR. The site's translation handler uses the entire article body as a catalog key, so replacing the body requires a new Weblate translation. Review before merge: synchronize translations through the standard project workflow, or explicitly accept temporary English fallback; do not manually edit lang/ in this PR.

Out of scope

A separate n8n integration article could be considered later only once a tested concrete workflow exists. No second article or follow-up issue is created in this PR.

No merge or production deployment is requested. The repository's existing PR workflow automatically published its isolated GitHub Pages review preview.

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

github-actions Bot commented Nov 11, 2026 •

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/pr-preview/pr-531/

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

Signed-off-by: Vitor Mattos <1079143+vitormattos@users.noreply.github.com>
Signed-off-by: Vitor Mattos <1079143+vitormattos@users.noreply.github.com>
@vitormattos
vitormattos merged commit 0f403c8 into main Nov 11, 2026
8 checks passed
@vitormattos
vitormattos deleted the docs/refresh-api-guide-official-openapi-20261110 branch November 11, 2026 03:40
@github-actions

Copy link
Copy Markdown
Contributor

🚀 Starting production deploy of site header and footer fragments...

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