SPB Git

Repository Public

RELEASE-REPORT.md 13.1 KB 150 lines markdown

1<!--2ORIX Docs3File: RELEASE-REPORT.md4Author: Simon-Pierre Boucher5Contact: contact@spboucher.ai6-->7# ORIX Docs 1.0.0 — Release Report89Date: 2026-11-21 · Build machine: Apple M5 Max (18 cores, 48 GB), macOS 27.0 (26A5425a), Xcode 27.2, Swift 6.4.2.1011Every figure below comes from a file in this repository or from the output of a command run on the build machine today.12Where something was not done or not verified, it says so.1314## 1. Summary1516| Item | Value |17|---|---|18| Version / build | 1.0.0 (2) |19| Bundle identifier | `ai.spboucher.orix.docs` |20| Minimum macOS | 15.0 |21| Architectures | arm64 + x86_64 (developed and tested on Apple silicon only; the Intel slice is built, not tested) |22| Developer ID signing | **Valid** — Developer ID Application: Simon-Pierre Boucher (3YM54G49SN), hardened runtime, secure timestamp, no entitlements |23| Notarization — application | **Accepted** — submission `5cbffb9c-d031-4702-81c6-ecb0d1068eca` |24| Notarization — disk image | **Accepted** — submission `794c8ee7-f0ef-491f-b7cc-7ab911771eca` |25| Stapling | Application and DMG stapled; `stapler validate` succeeded on both |26| Gatekeeper | `spctl`: application *accepted, source=Notarized Developer ID*; DMG *accepted, source=Notarized Developer ID*; the application inside the mounted DMG is accepted too |27| DMG | `ORIX-Docs-1.0.0.dmg`, 30 810 813 bytes, SHA-256 `94144d313c91a029c44f2dc34add72f84a67dc35881875bcd36615aed5e7e38e` |28| ZIP | `ORIX-Docs-1.0.0.zip`, 29 762 912 bytes, SHA-256 `1957d5e30931068ae1926ba69d58639e2a975b5aae4183e7f3ca004a9df9d75e` |29| Repository | Private bare repository `gitsrv:srv/git-private/orix-docs.git` (SSH only), branch `main`, tag `v1.0.0-build2` |30| Commit | The commit tagged `v1.0.0-build2` (`git rev-parse v1.0.0-build2`). Its source tree (`App/`, `Packages/`, `project.yml`) is what build 2 was compiled from; documentation and reports were finalised in the same commit |31| Public repository | https://git.spboucher.ai/orix-docs (published 2026-11-21 on the owner's instruction) |32| SPB Git release | **`v1.0.0`** — https://git.spboucher.ai/orix-docs/releases — DMG, ZIP, `SHA256SUMS.txt`, release notes; downloaded back and verified (checksums OK, DMG stapled, Gatekeeper: Notarized Developer ID) |3334The artifacts are in `dist/` on the build machine (not committed): `ORIX Docs.app`, the DMG, the ZIP, `SHA256SUMS.txt`, `release.json` (a copy of the latter is `docs/reports/release.json`).3536Build 1 was notarized first (submissions `79e71c2a-…` and `6f6104a3-…`, both accepted) and superseded the same day by build 2, which adds the image-loader confinement fix found during the documentation review.3738## 2. What was built3940A native macOS document application (SwiftUI + AppKit shell over a Swift package of engines, no SwiftUI in the engines):4142* **Editing engine** — value-type document model, Unicode-safe editing on composed-character boundaries, stories (body, headers, footers, notes), lists, tables (merge, split, sort, formulas), inline objects, footnotes and endnotes, comments, change tracking with accept/reject, find and replace, snapshot undo. Custom `NSView` canvas implementing `NSTextInputClient`.43* **Layout engine** — Core Text typesetting with a pagination engine written for this app: sections, columns, page/column/section breaks, headers and footers (first/odd/even), page numbering, widow/orphan control, keep-with-next, keep-lines, footnotes at the column foot, tables across pages with repeated header rows, floating objects with wrap, drop caps, hyphenation, generated contents / lists of figures and tables / bibliography with converging page numbers. The same renderer draws the screen, thumbnails, print and PDF.44* **Typography, styles, themes** — inherited paragraph and character styles, six themes, numbered headings, cross-references, captions.45* **Mathematics** — LaTeX equations typeset as vector glyphs (SwiftMath), inline and numbered display equations, a guard and fuzz tests against hostile input, LaTeX ↔ OMML ↔ MathML conversion.46* **References** — BibTeX/BibLaTeX, RIS and CSL-JSON import/export; six built-in citation styles (APA 7, Chicago author-date, MLA 9, IEEE, Vancouver, numeric). Not a CSL processor.47* **Formats** — native `.orixdoc` (ZIP container, SHA-256 manifest, schema versioning, recovery), DOCX, RTF, Markdown, HTML, plain text; PDF import as text; PDF publishing (vector text, embedded font subsets, links, destinations, outline, structure tags, crop marks).48* **Review** — tracked changes, comments with replies, document comparison with a side-by-side window and a merged document.49* **Auditor and research tools** — 24 checks with evidence and location; acronyms, unreferenced captions, repeated wording, cross-document search.50* **On-device intelligence** — Apple Foundation Models where available, proposals with Accept / Reject, plus rule-based tools that need no model.51* **Automation** — workflow engine, batch processing, `orixdocs` command-line tool (bundled in the app), App Intents for Shortcuts.52* **Templates** — 16 templates in English and Canadian French, built from real styles, fields and sections.53* **Interface** — six workspace modes, sidebar (outline, pages, find, review), nine-tab inspector, template chooser, settings; English and Canadian French (1 469 strings).5455## 3. Test results5657| Suite | Result | Source |58|---|---|---|59| Engine tests (Swift Testing, 10 targets, run serially) | **582 tests in 85 suites — all passed** | `docs/reports/test-results.json`, `Scripts/test.sh` |60| Interaction self-test, Debug build (real `NSEvent` key and mouse events) | **19 of 19 scenarios passed** | `docs/reports/test-results.json` |61| Interaction self-test, **notarized Release build 2** | **19 of 19 scenarios passed** | `docs/reports/selftest-release.json` |62| Kill-and-recover (`SIGKILL` after autosave in place), Debug and Release | **PASS** — typed text present after reopening | `Scripts/recovery-test.sh` |63| Engine line coverage | **92.9 %** of 28 196 lines (lower bound across test bundles) | `docs/reports/coverage.json` |64| XCUITest suite (`UITests/`, 10 tests) | **Not run** — macOS Automation Mode requires the owner's authentication on this Mac; the interaction self-test covers the same paths without it | `docs/development/testing.md` |6566Bugs found by the tests during development and fixed before this build include: tracked deletion over an inserted paragraph break (property test), a stack overflow and several traps in the math library on hostile LaTeX (fuzz test; fixed by a guard and a newer library revision), a deadlock in the font-availability check under parallel layout, the PDF outline silently missing (PDFKit does not persist it on macOS 27; replaced by the Core Graphics outline API), two crashes in the DOCX importer on hostile values, quadratic paths in the Markdown parser, and a stack overflow on deeply nested Markdown.6768## 4. DOCX compatibility6970Source: `docs/reports/docx-compatibility.md`, `docs/compatibility/docx.md`.7172* Corpus: 19 documents (8 produced by pandoc, 2 by LibreOffice, 8 hand-authored OOXML packages for tracked changes, comments, fields, drawings and hostile inputs, 1 authored by ORIX Docs).73* Import → export → re-import → export → re-import: 19/19 imported, model equal after both cycles on 19/19, text integrity 100 %, 172 feature checks passed, 0 failed.74* Independent readers on our exports: pandoc reads 19/19, `textutil` reads 19/19, LibreOffice converts 19/19 to PDF.75* **Microsoft Word itself was not used.** Perfect Word compatibility is not claimed. The corpus is small and synthetic (526 words).76* Unsupported features are reported to the user before export and after import (`FormatWarning`); the original DOCX is never overwritten — an imported file opens as a new untitled document.7778## 5. PDF export fidelity and pagination correctness7980* `Tests/DocLayoutTests/PDFTests.swift` (11 tests): page count and size, selectable and searchable text (PDFKit and Poppler), every font embedded (pdffonts), equation set in the math font rather than rasterised, external and internal links, outline mirroring the headings, document metadata, image resolution kept, structure tags present when requested, crop marks with trim and bleed boxes, page ranges, pending tracked changes published as accepted without leaving deleted text in the file, and **identical pagination between the screen layout and the print layout** on four templates.81* `Tests/DocLayoutTests/PaginationTests.swift` (45 tests): geometry, breaks, sections, columns, widow/orphan, keep rules, footnotes, tables across pages, generated contents with converging page numbers, headers and footers, typesetting, hit testing and caret movement.82* **No PDF/A or PDF/UA conformance is claimed**; no validator was run. Tagging limits are listed in `docs/architecture/pdf.md`.8384## 6. Long-document performance8586Release build, generated report of 487 pages (177 162 words, 1 884 blocks, 80 tables, 320 footnotes, 80 equations); source `docs/reports/benchmarks.json`.8788| Measure | Time |89|---|---|90| Cold layout (two passes) | 0.43 s |91| Relayout after one keystroke — median / p95 | 13 ms / 17 ms |92| Open native file and first layout | 0.94 s |93| Native save | 0.10 s |94| PDF export (487 pages) | 2.2 s |95| DOCX export / import | 1.15 s / 0.12 s |96| Find all (6 480 matches) | 20 ms |97| Peak memory of the benchmark process | 338 MB |9899On a 98-page document the keystroke relayout median is 2.3 ms (`docs/reports/benchmarks-100-pages.json`).100These are single runs on one machine; no page-count limit is promised.101102## 7. On-device AI compatibility103104* Requires macOS 26 or later with Apple Intelligence available; on macOS 15 the generative actions are disabled with an explanation and the rule-based tools remain.105* On the build machine the system model reported *available* (context 8 192 tokens). All actions ran; the "concise tone" action frequently returned the text unchanged (shown to the user as "no edit proposed").106* Proposals are never applied without Accept; one Undo restores the original (interaction-tested by the engineer through launch hooks, not by the self-test suite).107* No server-backed model type is referenced anywhere (a test scans the sources).108109## 8. Supported configurations110111* macOS 15.0 or later. Verified on macOS 27.0 / Apple M5 Max only. **Not tested**: macOS 15 and 26, Intel Macs, a clean second Mac.112* Interface: English, Canadian French.113114## 9. Publication and outstanding approvals115116On 2026-11-21 the owner asked for the repository to be made public and for the release to be created. Done the same day:1171181. Repository created on SPB Git and `main` pushed: https://git.spboucher.ai/orix-docs (the private copy `gitsrv:srv/git-private/orix-docs.git` holds the same history).1192. Tag `v1.0.0` (same commit as `v1.0.0-build2`) pushed; assets uploaded to the release: `ORIX-Docs-1.0.0.dmg`, `ORIX-Docs-1.0.0.zip`, `SHA256SUMS.txt`, `RELEASE-NOTES.md` — https://git.spboucher.ai/orix-docs/releases.1203. Verification from the public URLs: the three files download with HTTP 200 and the expected sizes; `shasum -a 256 -c SHA256SUMS.txt` reports OK for the DMG and the ZIP; `stapler validate` succeeds on the downloaded DMG; `spctl` reports *accepted, source=Notarized Developer ID*.1214. README on the forge: page served, image paths resolve, ten Mermaid blocks emitted. Not reviewed visually by a person.122123Still open: **macOS Automation Mode** authorization, if the XCUITest suite is to be run.124125## 10. Known limitations and remaining work126127The consolidated list is `docs/compatibility/limitations.md`. The main ones:128129* The canvas is a custom view: no autocorrection, grammar checking, text replacement, Writing Tools, Look Up or `NSTextFinder`; VoiceOver exposure is a flat text area and was reviewed by code inspection only.130* Table structure changes, atomic blocks and paragraph formatting are not change-tracked; cells hold paragraphs only (no nested tables); table rows do not split across pages; no column balancing.131* Six built-in citation styles; no CSL files.132* DOCX: nested tables and text boxes flattened; charts, SmartArt, OLE dropped with warnings; Word-native citation fields imported as text.133* PDF: table rows/cells are not tagged individually; no output intent; no PDF/A, PDF/UA.134* Math: constructs outside the typesetting library's subset (`align`, `\underbrace`, `\overset`, user macros…) render as their source with an error.135* App Intents never run from Shortcuts; AppleScript deferred; automatic updates (Sparkle) not implemented.136* Laying out documents from many threads at once can stall in the system font registry: tests run serially and batch jobs bound their concurrency.137138## 11. How to reproduce139140```141Scripts/test.sh all            # engine tests, interaction self-test, recovery test → docs/reports/test-results.json142Scripts/coverage.sh            # → docs/reports/coverage.json143cd Packages/ORIXDocsKit && swift run -c release orixbench 40 ../../docs/reports/benchmarks.json144Scripts/docx-compat.sh         # → docs/reports/docx-compatibility.md145Scripts/screenshots.sh         # → docs/screenshots/146Scripts/check.sh               # secret scan and file headers147Scripts/release.sh             # Release build, Developer ID signature148Scripts/notarize.sh            # notarization, stapling, DMG, ZIP, checksums → dist/149```150
Files main
Menu

Theme