From 4b3748ed5c0dbfc404ce9ed69b3e33fb9640156b Mon Sep 17 00:00:00 2001 From: OKAN TIKTAS <346542017+OKAN-SOFTWARE@users.noreply.github.com> Date: Sun, 8 Nov 2026 08:55:44 -0500 Subject: [PATCH] docs: mark Doc2FAQ v0.5.0 as published --- CHANGELOG.md | 4 ++-- README.md | 8 ++++---- docs/RELEASING.md | 2 +- scripts/verify-website-build.mjs | 7 ++++--- website/index.html | 4 ++-- 5 files changed, 13 insertions(+), 12 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 1174e92..aa672a9 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,7 +2,7 @@ All notable Doc2FAQ changes are recorded here. Version numbers follow semantic versioning; entries describe shipped source functionality and do not imply an external AI service. -## [0.5.0] — Unreleased (release candidate) +## [0.5.0] — 2026-11-08 ### Added - Browser PDF/Word (.docx) import and paginated export with local processing, PDF page/file/text limits, bounded DOCX XML decompression, optional references, and clear unsupported-file/font errors. @@ -22,7 +22,7 @@ All notable Doc2FAQ changes are recorded here. Version numbers follow semantic v - **Clear saved data** is now a prominent, high-contrast action with a confirmation prompt. Cancel leaves the browser's saved draft intact; confirming removes only browser storage and keeps the current workspace open. - GitHub Actions now uses Node 24-based checkout/setup-java actions and pins Ubuntu 24.04 to avoid runner-label migration notices. - The v0.5.0 release gate validates **Java 21–26** with Java 21-compatible bytecode. Java 27 formal support is deferred, not declared incompatible: a transient JDK-download HTTP 504 caused an initial CI failure, and a later rerun **passed Java 27 build/tests and packaged-JAR smoke checks**. -- Release-candidate source version is 0.5.0; v0.4.0 remains the published release until the new artifacts are validated and released. +- Published v0.5.0 with a verified standalone JAR, Windows ZIP, release notes, and SHA-256 checksums. ## 0.4.0 — 2026-10-29 diff --git a/README.md b/README.md index 69fc1eb..0539bb5 100644 --- a/README.md +++ b/README.md @@ -6,18 +6,18 @@ Doc2FAQ is a Java 21 / Spring Boot document-to-FAQ workbench. Paste text or uplo Created by **Okan Tiktas** · [OKAN-SOFTWARE](https://github.com/OKAN-SOFTWARE). -> **Latest published download: v0.4.0 — Review, Save & Export.** Download the ready-to-run JAR or Windows ZIP from [GitHub Releases](https://github.com/OKAN-SOFTWARE/Doc2FAQ/releases/tag/v0.4.0). +> **Latest release: v0.5.0 — Source & Review.** Download the ready-to-run JAR, Windows ZIP, and checksum file from [GitHub Releases](https://github.com/OKAN-SOFTWARE/Doc2FAQ/releases/tag/v0.5.0). -## Current source: v0.5.0 release candidate — Source & Review +## New in v0.5.0 — Source & Review -I redesigned Doc2FAQ with an illustrated homepage and a responsive FAQ workbench. Visit the [product homepage](https://okantiktas.com/projects/doc2faq/) for an overview, or try the [interactive browser demo](https://okantiktas.com/projects/doc2faq/demo/) to import documents, review FAQs, and export the results directly in your browser. The browser demo and downloadable Java application have different processing engines, so their FAQ suggestions may differ. See the [v0.5.0 changes](CHANGELOG.md#050--unreleased-release-candidate) and [design system](docs/DESIGN-SYSTEM.md) for details. +I redesigned Doc2FAQ with an illustrated homepage and a responsive FAQ workbench. Visit the [product homepage](https://okantiktas.com/projects/doc2faq/) for an overview, or try the [interactive browser demo](https://okantiktas.com/projects/doc2faq/demo/) to import documents, review FAQs, and export the results directly in your browser. The browser demo and downloadable Java application have different processing engines, so their FAQ suggestions may differ. See the [v0.5.0 changes](CHANGELOG.md#050--2026-11-08) and [design system](docs/DESIGN-SYSTEM.md) for details. - **Source beside answer:** select **View source beside answer** on an FAQ to highlight all of its original passages in a read-only document viewer beside the review editor on desktop (stacked on smaller screens). References still use extracted-text lines, not PDF page numbers. Manual FAQs have no automatic reference. - **Review status:** FAQs start as **Needs review**. Mark a complete answer **Approved** after checking it. Editing its question or answer, or merging FAQs, returns it to **Needs review**. Moving an item preserves approval; Undo restores the status from before a removal or merge. - **Search and review filters:** combine a case-insensitive question/answer search with **All statuses**, **Needs review**, or **Approved**. The summary shows visible, approved, and pending counts. **Clear filters** restores the full list. Filters never change what is saved, previewed, or exported: all FAQs remain included, and incomplete entries still block export. - **Saved work compatibility:** approval status is preserved in project downloads and optional autosave. New saves use project schema 2; v0.4 schema-1 files still open with FAQs marked Needs review. Schema-2 files require v0.5 or later to reopen. -The release-candidate branch uses `0.5.0` in `pom.xml` (`target/doc2faq-0.5.0.jar`). The latest published download remains v0.4.0 until the release candidate passes validation and v0.5.0 is published. This branch is not itself a published release. +The source builds version `0.5.0` from `pom.xml` as `target/doc2faq-0.5.0.jar`. The published ZIP contains the same JAR, a Windows launcher, and a quick-start guide; release downloads also include SHA-256 checksums. ## New in v0.4.0 diff --git a/docs/RELEASING.md b/docs/RELEASING.md index a4cee62..ed19993 100644 --- a/docs/RELEASING.md +++ b/docs/RELEASING.md @@ -1,6 +1,6 @@ # Doc2FAQ release checklist -**Release-candidate branch:** `0.5.0`. **Latest published download:** v0.4.0. The next planned release is **v0.5.0 — Source & Review**. The release-candidate branch is not a published release. Merging source changes does not publish a release or update an installed JAR. Keep existing tags and assets unchanged. +**Latest published download:** v0.5.0 — Source & Review. This checklist records how I validated and packaged the v0.5.0 release. A source merge alone does not update existing JAR downloads or running Java processes; each release needs its own tested build and assets. ## Validate the release candidate diff --git a/scripts/verify-website-build.mjs b/scripts/verify-website-build.mjs index 14de22c..e12ffa1 100644 --- a/scripts/verify-website-build.mjs +++ b/scripts/verify-website-build.mjs @@ -13,10 +13,11 @@ assert.match(home, /href="\.\/styles\.css"/, 'Homepage loads styles relative to assert.match(home, /
/, 'Mobile visitors can open homepage navigation'); assert.doesNotMatch(home, /href="\/(?:demo\/|styles\.css|)"/, 'No domain-root homepage links'); assert.match(home, /id="whats-new"/, 'Homepage includes the release notes preview'); -assert.match(home, /v0\.5\.0 PREVIEW/, 'Unreleased version is visibly labeled'); -assert.match(home, /Release candidate — not published yet/, 'Unreleased status is explicit'); +assert.match(home, /v0\.5\.0 AVAILABLE/, 'Published version is visibly labeled'); +assert.match(home, /Released November 8, 2026/, 'Release date is explicit'); assert.match(home, /Java 21–26/, 'Homepage reflects the required compatibility matrix'); -assert.match(home, /v0\.4\.0 is still the latest published download/, 'Latest published release is identified accurately'); +assert.match(home, /v0\.5\.0 Java app and Windows ZIP are ready to download/, 'Current release downloads are identified accurately'); +assert.match(home, /releases\/tag\/v0\.5\.0/, 'Homepage links directly to the published release'); assert.match(demo, /href="\.\.\/"/, 'Demo navigates back to its own homepage'); assert.match(demo, /THE INTERACTIVE PLAYGROUND/, 'Demo is branded consistently'); assert.match(demo, /id="file-input"/, 'File import remains available'); diff --git a/website/index.html b/website/index.html index d4b407a..f5e45c0 100644 --- a/website/index.html +++ b/website/index.html @@ -88,14 +88,14 @@

DOC2FAQ

✳ FRESH FROM THE WORKBENCH

WHAT'S NEW?

-
v0.5.0 PREVIEWRelease candidate — not published yet
+
v0.5.0 AVAILABLEReleased November 8, 2026

HELLO, NEW LOOK.

A cheerful illustrated homepage and a matching, mobile-friendly workbench that keeps your document front and center.

REVIEW WITH CONFIDENCE.

See source highlights, approve answers, search your draft, and reopen saved projects for another pass.

TAKE IT WITH YOU.

Import PDF and Word files in the browser demo, then export as PDF, DOCX, Markdown, JSON, or HTML.

-

Java 21–26 is the required v0.5.0 test matrix. Java 27 passed a separate CI run; formal support can follow later. v0.4.0 is still the latest published download.

READ RELEASE NOTES
+

v0.5.0 is tested on Java 21–26. Java 27 passed a separate exploratory CI run, with formal support planned for a later version. The v0.5.0 Java app and Windows ZIP are ready to download.

RELEASE NOTES + DOWNLOAD