Skip to content

Finish reproducible brand manual and release process #3

Description

@vitormattos

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

Completed baseline

  • Typst selected and documented in ADR
  • manual/main.typ is canonical source
  • local build command documented
  • CI build with exact Typst 0.15.1 pin
  • 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
  • canonical artwork and deterministic derivative generation baseline
  • basic visual manual structure exists

Completion work

Use PR #8 / docs/libresign-parity-plan.md as the implementation checklist.

Editorial

  • add/how-to-use page and clarify scope
  • review LibreCode-specific purpose, audience, positioning, and messaging
  • document free-software values in practical language
  • document cooperative identity/community participation
  • expand voice and tone
  • add partner/third-party use guidance
  • review licensing, trademark, ownership, and official-source language
  • use plain, direct Portuguese and avoid unnecessary jargon

Logo and technical diagrams

  • confirm approved logo variants and formats
  • refactor clear-space geometry so canonical SVG -> deterministic Python technical SVG -> Typst composition only
  • remove cross-brand/dead Typst code
  • confirm minimum-size rules from LibreCode-specific evidence
  • add approved correct/incorrect-use examples

Typst maintainability

  • replace positional TOC tuple indexes with named fields
  • adopt Typstyle through typstyle-rs/typstyle-action, pinned to full SHA
  • document Tinymist as recommended editor diagnostics/linter
  • keep exact Typst compiler version for reproducible output
  • document source-maintenance conventions

PDF accessibility

  • semantic cover/document title
  • semantic heading hierarchy
  • linked table of contents
  • PDF bookmarks
  • page-top TOC destinations
  • meaningful image alt text
  • decorative section numbers marked as artifacts
  • correct document language and reading order
  • validate PDF/UA-1 independently with veraPDF
  • perform human visual/accessibility review

CI and repository quality

  • pin all third-party GitHub Actions to full commit SHAs with version comments
  • make scripts/check_brand.py enforce Action pins
  • configure grouped weekly Dependabot updates for github-actions
  • rely on the DCO GitHub App for sign-off enforcement
  • preserve REUSE and brand quality checks

Licensing and publication

  • add root LICENSE with exact CC BY-SA 4.0 text
  • clarify README multi-license scope
  • remove placeholder examples/ if examples live directly in the manual
  • establish/verify mutable latest development prerelease
  • visually inspect the generated manual page by page

Release gate

The manual may be used during development/homologation through the mutable latest release.

Do not create the first stable v1.0.0 simply because the manual is usable.

Before v1.0.0:

Distribution contract

  • Git/Typst source is canonical.
  • Normal CI builds expose the PDF as a temporary Actions artifact.
  • latest is the mutable development/homologation release.
  • Tagged v* releases are permanent approved versions.

Activity

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

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions