Skip to content

docs(site): improve technical discovery and canonical metadata - #569

Merged
vitormattos merged 2 commits into
mainfrom
docs/improve-technical-discovery-20261113
Nov 14, 2026
Merged

vitormattos merged 2 commits into
mainfrom
docs/improve-technical-discovery-20261113

Conversation

@vitormattos

@vitormattos vitormattos commented Nov 13, 2026 •

Copy link
Copy Markdown
Member

Purpose

Make the existing LibreSign technical information discoverable from the homepage, Features navigation, FAQ and IT page without duplicating the API guide updated in #531.

Changes

  • Link the existing API Integration Guide and the official version-selection documentation from Features navigation, homepage integration card, FAQ and IT page.
  • Clarify that LibreSign is a Nextcloud app (not a standalone server), API use requires an authorized Nextcloud account and installation permissions, external recipients may sign through invitations without Nextcloud accounts where configured, and signed documents are retrieved only when authorized.
  • Route IT documentation links through the official version chooser instead of unversioned manual paths.
  • Correct relative canonical, hreflang and social URL metadata to absolute URLs using the configured site origin, preserving absolute preview URLs.
  • Add source-level regression tests for technical navigation, requirements, original article authorship/date, Weblate rules and metadata.

No additional article was created. The existing API-guide source, slug, author, historical publication date, existing structured data and translation catalogs remain untouched. New English strings will require normal Weblate translation; they intentionally fall back to English until translated.

Evidence / validation (isolated checkout of main e57d6ad)

  • npm run test:js: 23 passed, 0 failed.
  • php vendor/bin/phpunit --no-coverage (official PHP 8.3 container): 68 tests, 161 assertions, passed.
  • npm run prod (official project container): built successfully.
  • git diff --check: passed.
  • Checked generated production HTML for home, features, FAQ, IT, API guide and pt-BR IT: correct absolute canonical and eight absolute hreflang links per inspected page; contextual guide/manual links rendered.
  • Checked public destinations: docs home, existing API guide, features and FAQ returned HTTP 200; no production deploy was triggered.
  • Signed commit: 86e3cd94b3edd8d74c026ef319c909940274c471, signature verified and DCO matches author.

Review notes

The repository's pull-request preview workflow may publish an isolated preview automatically. This request does not authorize merge or production deployment. Please review desktop/mobile rendering and translation fallbacks before merge.

Final CI and render evidence

  • 7/7 GitHub checks passed on commit 86e3cd94: preview, Shellcheck, production build, PHPUnit, translations validation, JavaScript tests and DCO.
  • Home preview, IT/requirements preview, FAQ preview and pt-BR IT preview all returned HTTP 200.
  • Chrome rendered the IT page at desktop 1440×900 and emulated mobile 390×844. CDP measured mobile innerWidth=390, document.scrollWidth=390, and the requirements heading width 310px; no horizontal document overflow. Mobile screenshot visually inspected after device-metrics emulation; initial plain headless-window capture had misleading clipping caused by its viewport behavior.
  • Local rendered mobile evidence SHA-256 13d7bdd02db48358050040e8fd5efe2a12ed4567575afff43230a557767aa79a (temporary test environment, not added to the repository).
  • New technical text is English until translated by Weblate. No production deployment or merge.

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

github-actions Bot commented Nov 13, 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-569/

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

@YvesCesar
YvesCesar self-requested a review November 14, 2026 20:00

@YvesCesar YvesCesar left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Thanks @vitormattos !

I made a few revisions. Could you take a look?

Comment thread source/_layouts/main.blade.php Resolved
Comment thread source/index.blade.php Resolved
Comment thread source/tecnical-details.blade.php Resolved
Comment thread source/tecnical-details.blade.php Resolved
Comment thread tests/js/technical-discovery.test.mjs Resolved
Normalize social image URLs, improve link visibility and card spacing,
and validate the rendered HTML during preview builds.

Signed-off-by: Vitor Mattos <1079143+vitormattos@users.noreply.github.com>
@vitormattos
vitormattos merged commit 7ab33fc into main Nov 14, 2026
7 checks passed
@vitormattos
vitormattos deleted the docs/improve-technical-discovery-20261113 branch November 14, 2026 20:33
@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.

2 participants