Skip to content

Finish reproducible brand manual and release process #3

Description

@vitormattos

The LibreSign manual is authored in Typst and built reproducibly in CI.

Completed

  • Typst selected and documented in ADR
  • manual/main.typ is canonical source
  • local build command documented
  • CI build with pinned Typst 0.15.1
  • PDF/UA-1 build target
  • generated PDF uploaded as GitHub Actions artifact
  • release workflow added for v* tags
  • release workflow publishes manual PDF, SVG, PNG, PDF logo derivatives, and SHA256SUMS
  • professional visual layout completed
  • normative clear-space diagram generated from native vector/source geometry
  • correct/incorrect-use examples added to the manual
  • generated PDF visually reviewed
  • linked table of contents and PDF bookmarks added
  • PDF accessibility structure improved with semantic headings, alt text, artifacts, and page-top destinations
  • PDF/UA-1 independently validated with veraPDF in CI
  • current main branch build, REUSE, and brand-quality workflows pass
  • trademark/software registration references documented

Remaining

  • apply repository metadata tracked in Apply canonical repository metadata #6
  • complete external homologation/review of the manual
  • incorporate approved review feedback, if any
  • prepare a fresh v1.0.0 release PR from the approved main
  • create and push tag v1.0.0
  • verify the versioned release workflow and published assets

Distribution contract

  • Git/Typst source is canonical.
  • Normal CI builds expose brand-manual.pdf as a temporary Actions artifact.
  • The mutable latest prerelease publishes the current development build from main.
  • Tagged v* releases publish permanent versioned PDF and artwork assets in GitHub Releases.

The repository metadata is complete. The current manual is usable through the mutable latest development release, but stable v1.0.0 is intentionally deferred until external homologation/review is complete. PR #22 was closed without merge. After approval, prepare a fresh release PR from the current main; the existing release workflow will build, validate, checksum, and publish the versioned artifacts.

Activity

  1. self-assigned this
    on Sep 24, 2026
  2. vitormattos commented on Sep 24, 2026

    @vitormattos
    MemberAuthor

    Toolchain decision recorded in docs/decisions/0001-manual-toolchain.md: Typst is the accepted initial publishing stack. A minimal manual/main.typ and GitHub Actions build workflow are now in place; the remaining work is migrating and validating the complete historical manual content/assets.

  3. vitormattos commented on Sep 24, 2026

    @vitormattos
    MemberAuthor

    Historical manual audit completed. The 7-page manual covers primary logo/icon, institutional palette, color variants, clear-space construction, minimum dimensions, and Catamaran typography.

    The current website has evolved away from parts of this manual (Montserrat and #184c4e as primary digital token). Issue #7 now tracks the required reconciliation before the new Typst manual declares a final contemporary palette/type hierarchy.

  4. changed the title [-]Create reproducible open-source brand manual[/-] [+]Finish reproducible brand manual and release process[/+] on Sep 24, 2026
  5. vitormattos commented on Sep 24, 2026

    @vitormattos
    MemberAuthor

    Editorial redesign implemented. Both brand manuals now share the same content architecture and editorial engine (manual/components.typ), while manual/theme.typ contains brand-specific color, typography, and motif tokens. Official open-source fonts are vendored from Google Fonts under OFL-1.1 and used via --font-path source/fonts. The manuals now include full-page section openers, branded covers/back covers, logo construction/composition, primary/reversed applications, color swatches, typography specimens, clear-space guidance, minimum-size guidance, accessibility, and governance. The shared structure is documented in docs/manual-content-contract.md; open Typst reference implementations are documented in ADR 0002. Builds, Brand quality, and REUSE are passing. The remaining work in this issue is final visual QA of the latest PDFs and any last art-direction refinements before the first versioned release.

  6. vitormattos commented on Sep 24, 2026

    @vitormattos
    MemberAuthor

    Visual QA pass completed against the original manual and the rendered PDF. Fixed logo framing/cropping, typography specimen line breaks, explicit clear-space construction, duplicate application markup, and clickable back-cover URL. Clear-space rules are now normative in guidelines/visual-identity.md as well as illustrated in the PDF. PDF/UA manual build, Brand quality, and latest publication all passed for the refined manual source.

  7. vitormattos commented on Sep 24, 2026

    @vitormattos
    MemberAuthor

    Asset/manual pipeline overhaul completed. The repository now has one editable canonical *-master.svg, one machine-readable source/artwork/brand-assets.json, and a single scripts/build_assets.py used by local builds, asset CI, manual CI, the continuous latest release, and versioned releases. Inkscape --export-area-drawing computes the real drawing bounds; safe framing, primary/reversed/monochrome variants, PNG/PDF/SVG exports, and clean-space reference glyph crops are deterministic outputs. The manual consumes only generated assets from build/assets/, never hand-edited derivatives. LibreCode clean space is now bound to the width of the actual D glyph from the wordmark; LibreSign uses the actual E glyph from the wordmark as the non-interference module. Visual QA confirmed the LibreCode page-7 clipping is gone and both clean-space pages use the measured canonical geometry. Current Build brand manual, Brand quality, REUSE, and Publish latest brand build workflows are green.

  8. vitormattos commented on Sep 25, 2026

    @vitormattos
    MemberAuthor

    Clear-space construction was refined again using the original designer manuals as the visual reference. LibreSign now uses the actual E extracted from the wordmark as the guide glyph, recolored automatically by the asset generator; top/bottom E remain upright, side E are rotated, and all four are centered on the dashed exclusion boundary. LibreCode now shows the actual D reference explicitly as the source of X, then applies X around the mark between the inner artwork frame and outer protection frame. Both pages are generated from the canonical master via scripts/build_assets.py; no manual derivative editing is involved. Latest PDF build, Brand quality, REUSE, and latest publication are green, and page 13 was visually inspected after rendering.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type

Fields

Priority

None yet

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions