# Document Generation — current status

**Version 1.0**, built and published by the shared `ci-workflows` Maven pipeline to the KOF22 Gitea Maven registry (`com.kingsrook.qbits`). `mvn deploy` runs every module's tests once. Depends on QQQ Core `4.1.0-RC.22`, Record Files `0.1.0-RC.1` and Scripting `1.0.0`.

## Purpose

User-defined document templates, sizes, PDF/ZPL generation, barcode rendering and integrations with scripting, retained files and printing.

## Repository layout

`foundation/` owns metadata, revisions, requests and audit contracts. `renderer/` contains rendering and vendored corresponding source. `bridges/` contains optional integrations. The root Maven reactor lists all modules.

## Building and installation

Use Java 21 and the included Maven wrapper. Component example: `./mvnw -pl foundation -am verify`. Database tests use their Testcontainers fixtures and require Docker. The full `./mvnw verify` currently has the blockers below; it is not an installation proof.

## Evidence retained

Foundation: 225 tests passed with zero failures/errors/skips, Checkstyle clean and coverage gate met. The definition-rename change (native `document_generation_{type,stock,template}_author_rename` actions, see [authoring](AUTHORING.md)) was first qualified by GG Forge as a local patch (37 rename-related tests on H2, MySQL and PostgreSQL 17) and then re-verified on this branch with `./mvnw -pl foundation -am verify`: 232 tests passed with zero failures/errors/skips, Checkstyle clean and coverage gate met, including the Docker MySQL 8.4 and PostgreSQL 17 suites. No schema change. Renderer bridge: 52 tests passed; remote transport: 19 passed. A clean consumer resolved the foundation/remote modules. The patched OpenHTML module passed 15 tests. These are component results, not a complete released-system acceptance.

## Source and release state

The starting source was extracted from Website-Backend commit b6fb23825a87412397dec703b9617148ae7eb601, then adapted for standalone packaging; existing licenses are preserved. See [known issues](KNOWN-ISSUES.md) and the README for the API and integration documentation.