diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index d7243e0..98136d2 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -2,6 +2,8 @@ name: Verify Doc2FAQ on: push: + branches: + - main pull_request: permissions: @@ -9,20 +11,55 @@ permissions: jobs: build-and-test: - runs-on: ubuntu-latest - timeout-minutes: 10 + runs-on: ubuntu-24.04 + timeout-minutes: 20 + name: Java ${{ matrix.java }} compatibility + strategy: + fail-fast: false + max-parallel: 2 + matrix: + java: ['21', '22', '23', '24', '25', '26'] steps: - - uses: actions/checkout@v4 - - uses: actions/setup-java@v4 + - uses: actions/checkout@v7 + - uses: actions/setup-java@v6 with: distribution: temurin - java-version: '21' + java-version: ${{ matrix.java }} cache: maven - name: Build and test - run: mvn -B -ntp verify + run: mvn -B -ntp clean verify + + - name: Smoke test packaged Java app + run: bash scripts/smoke-packaged-jar.sh target/doc2faq-0.5.0.jar - name: Test browser export safety + if: matrix.java == '21' run: node --test src/test/js/*.test.cjs - - name: Build static browser demo - run: node scripts/build-web-demo.mjs + - name: Build Doc2FAQ homepage and static browser demo + if: matrix.java == '21' + run: | + node scripts/build-website.mjs + test -f website-dist/index.html + test -f website-dist/styles.css + test -f website-dist/demo/index.html + test -f website-dist/demo/retro.css + node scripts/verify-website-build.mjs + + # The main-branch ruleset requires a check named "build-and-test". + # Keep that stable status only after every Java matrix job succeeds. + required-status: + name: build-and-test + runs-on: ubuntu-24.04 + needs: [build-and-test] + if: ${{ always() }} + steps: + - name: Require all Java compatibility jobs to pass + env: + MATRIX_RESULT: ${{ needs['build-and-test'].result }} + run: | + if [ "$MATRIX_RESULT" != "success" ]; then + echo "Java 21–26 compatibility checks did not all pass: $MATRIX_RESULT" + exit 1 + fi + echo "All Java 21–26 compatibility checks passed." diff --git a/.github/workflows/publish-v0.5.0.yml b/.github/workflows/publish-v0.5.0.yml new file mode 100644 index 0000000..390b069 --- /dev/null +++ b/.github/workflows/publish-v0.5.0.yml @@ -0,0 +1,121 @@ +name: Publish Doc2FAQ v0.5.0 + +# First run automatically when this workflow lands on main. Manual reruns +# remain available, but the existing-release check prevents duplicate tags. +on: + push: + branches: [main] + paths: + - .github/workflows/publish-v0.5.0.yml + workflow_dispatch: + +permissions: + contents: read + +concurrency: + group: doc2faq-v0.5.0-release + cancel-in-progress: false + +jobs: + compatibility: + name: Release Java ${{ matrix.java }} compatibility + runs-on: ubuntu-24.04 + timeout-minutes: 20 + strategy: + fail-fast: false + max-parallel: 2 + matrix: + java: ['21', '22', '23', '24', '25', '26'] + steps: + - uses: actions/checkout@v7 + - uses: actions/setup-java@v6 + with: + distribution: temurin + java-version: ${{ matrix.java }} + cache: maven + - name: Build, test, and smoke-test the packaged application + run: | + mvn -B -ntp clean verify + bash scripts/smoke-packaged-jar.sh target/doc2faq-0.5.0.jar + + publish: + if: github.repository == 'OKAN-SOFTWARE/Doc2FAQ' && github.ref == 'refs/heads/main' + # GitHub waits for every Java matrix entry; any failure skips publication. + needs: [compatibility] + runs-on: ubuntu-24.04 + timeout-minutes: 25 + permissions: + contents: write + steps: + - uses: actions/checkout@v7 + with: + fetch-depth: 0 + + - uses: actions/setup-java@v6 + with: + distribution: temurin + java-version: '21' + cache: maven + + - uses: actions/setup-node@v4 + with: + node-version: '22' + + - name: Refuse to replace an existing v0.5.0 release or tag + env: + GH_TOKEN: ${{ github.token }} + run: | + if gh release view v0.5.0 >/dev/null 2>&1; then + echo "v0.5.0 is already published. Refusing to overwrite it." + exit 1 + fi + if [ -n "$(git tag -l v0.5.0)" ]; then + echo "The v0.5.0 tag already exists. Review it before publishing." + exit 1 + fi + + - name: Build and verify the release JAR + run: | + mvn -B -ntp clean verify + bash scripts/smoke-packaged-jar.sh target/doc2faq-0.5.0.jar + + - name: Verify browser demo and Doc2FAQ homepage + run: | + node --test src/test/js/*.test.cjs + node scripts/build-website.mjs + node scripts/verify-website-build.mjs + + - name: Package the Windows and standalone downloads + shell: bash + run: | + set -euo pipefail + mkdir -p release/staging/Doc2FAQ-0.5.0 + cp target/doc2faq-0.5.0.jar release/doc2faq-0.5.0.jar + cp release/doc2faq-0.5.0.jar release/staging/Doc2FAQ-0.5.0/ + cp packaging/Start-Doc2FAQ.cmd packaging/WINDOWS-QUICK-START.md release/staging/Doc2FAQ-0.5.0/ + # Windows cmd.exe expects CRLF-terminated batch files. + sed -i 's/$/\r/' release/staging/Doc2FAQ-0.5.0/Start-Doc2FAQ.cmd + ( + cd release/staging + zip -q -r ../Doc2FAQ-0.5.0-Windows.zip Doc2FAQ-0.5.0 + ) + unzip -t release/Doc2FAQ-0.5.0-Windows.zip + unzip -p release/Doc2FAQ-0.5.0-Windows.zip Doc2FAQ-0.5.0/doc2faq-0.5.0.jar | cmp - release/doc2faq-0.5.0.jar + ( + cd release + sha256sum doc2faq-0.5.0.jar Doc2FAQ-0.5.0-Windows.zip > SHA256SUMS.txt + sha256sum -c SHA256SUMS.txt + ) + + - name: Publish exactly the tested commit + env: + GH_TOKEN: ${{ github.token }} + run: | + gh release create v0.5.0 \ + --target "$GITHUB_SHA" \ + --title "Doc2FAQ v0.5.0 — Source & Review" \ + --notes-file docs/RELEASE-NOTES-0.5.0.md \ + --latest \ + release/doc2faq-0.5.0.jar \ + release/Doc2FAQ-0.5.0-Windows.zip \ + release/SHA256SUMS.txt diff --git a/.gitignore b/.gitignore index 845489f..03558a5 100644 --- a/.gitignore +++ b/.gitignore @@ -17,3 +17,4 @@ Thumbs.db # Generated browser demo (built from tracked sources) /demo-dist/ +/website-dist/ diff --git a/CHANGELOG.md b/CHANGELOG.md index 78189b5..1174e92 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,11 +2,13 @@ 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 +## [0.5.0] — Unreleased (release candidate) ### 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. +- Browser PDF exports now embed bundled DejaVu Sans regular/bold font subsets instead of standard Helvetica, fixing Turkish and extended-Unicode text copied from web pages; unchanged Word exports continue to preserve the source characters. - Browser-only website demo built from the shared frontend, with simplified text drafting, explicit PDF/Word limitations, homepage navigation, and text exports. +- Redesigned Doc2FAQ homepage and matching browser/Java workbench with an original document mascot, responsive illustrated cards, accessible focus styles, reduced-motion support, and a reproducible `website-dist/` build. The "What's new" section distinguishes development previews from published downloads. - Source & Review user guide and current documentation for development builds, schema compatibility, and v0.5.0 release preparation. - Read-only source viewer highlighting the selected FAQ's exact original passages, with a stacked layout on narrow screens. - Per-FAQ Needs review / Approved status, persisted in saved projects and optional browser autosave. @@ -16,7 +18,11 @@ All notable Doc2FAQ changes are recorded here. Version numbers follow semantic v - Editing questions or answers and merging FAQs reset approval; incomplete FAQs cannot be approved. - Project schema 2 stores review status and upgrades schema-1 projects with Needs review defaults. Older application versions reject schema-2 files instead of silently discarding approval state. - Filters affect only the review list; saving, export preview, and all export formats retain every FAQ in draft order. -- Development version is 0.5.0-SNAPSHOT; v0.4.0 remains the published release. +- Export formats now open with PDF first and Word (.docx) second; the default download name uses `.pdf`. +- **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. ## 0.4.0 — 2026-10-29 diff --git a/README.md b/README.md index 57bb703..69fc1eb 100644 --- a/README.md +++ b/README.md @@ -8,19 +8,21 @@ 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). -## Current source: v0.5.0-SNAPSHOT — Source & Review +## Current source: v0.5.0 release candidate — 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. - **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. -Development builds use `0.5.0-SNAPSHOT` in `pom.xml` (`target/doc2faq-0.5.0-SNAPSHOT.jar`). The latest published download remains v0.4.0 until a new release is validated and published. +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. ## New in v0.4.0 - **Save work / Open saved work:** a versioned JSON file preserves source text, title, mode, draft order, edits, original excerpts, and duplicate-review choices. Incomplete FAQs can be saved too. Project files are limited to 4 MB and validated before replacing the workspace. -- **Optional browser autosave:** off by default. Enabling it stores the complete source and draft on this browser's origin and restores them on reload. Disabling autosave or using **Clear saved data** removes Doc2FAQ's saved data without clearing your open workspace. Storage failures leave the draft open; use **Save work** as a backup. +- **Optional browser autosave:** off by default. Enabling it stores the complete source and draft on this browser's origin and restores them on reload. The highlighted **Clear saved data** button asks for confirmation before removing the browser copy; canceling preserves it, and confirming leaves your current workspace open. Disabling autosave also removes the stored copy. Storage failures leave the draft open; use **Save work** as a backup. - **Source references:** expand **Show source** to see the original section, extracted-text line range, and exact passage. Edited questions and answers are marked for rechecking. References use text lines, not PDF page numbers; manually added FAQs have no automatic reference. - **Duplicate review:** distinct passages are retained even if their questions cover the same topic. Similar questions are flagged using a word-overlap heuristic. Choose **Keep both** or **Merge into this FAQ**. Merging keeps both answers and all source references; **Undo removal / merge** restores the previous items until another FAQ edit, addition, reorder, or review choice. Exact duplicate question/answer pairs are still filtered. The maximum remains 30 FAQs. - **PDF and Word export:** edited content, a centered document title, readable page layout, metadata, and page numbers. Optionally include section/line references and edited-answer notices. PDF embeds Lato Regular and Bold (see `src/main/resources/fonts/LICENSE-Lato.txt`); if text contains a glyph that font cannot represent, export returns an error and suggests DOCX. @@ -52,15 +54,15 @@ The document placeholder now uses neutral Q&A prompts, and Generate Mode's sampl ## Try it in your browser -[Open the interactive browser demo](https://okantiktas.com/projects/doc2faq/) · [Source & Review user guide](docs/USER-GUIDE.md) · [Demo capabilities and deployment](docs/WEB-DEMO.md) +[Doc2FAQ homepage](https://okantiktas.com/projects/doc2faq/) · [Try the interactive browser demo](https://okantiktas.com/projects/doc2faq/demo/) · [Source & Review user guide](docs/USER-GUIDE.md) · [Demo capabilities and deployment](docs/WEB-DEMO.md) · [Design system](docs/DESIGN-SYSTEM.md) -The demo processes pasted text and TXT/Markdown in your browser, using simplified rules. Try both drafting modes, source highlighting, editing, approval status, duplicate review, search/filters, saved projects, and Markdown/JSON/HTML exports. PDF/Word (.docx) import and export also run locally in the browser; PDF uploads are limited to 5 MB and 50 pages, and DOCX to 5 MB. Scanned PDFs need external OCR. The demo does not run a Java backend and its drafting rules remain simplified. Document libraries load from a version-pinned CDN when needed; document content is not uploaded. Browser PDF export uses standard Latin fonts and suggests Word when a character cannot be represented. The development demo may include features newer than the latest release download. +The demo processes pasted text and TXT/Markdown in your browser, using simplified rules. Try both drafting modes, source highlighting, editing, approval status, duplicate review, search/filters, saved projects, and Markdown/JSON/HTML exports. PDF/Word (.docx) import and export also run locally in the browser; PDF uploads are limited to 5 MB and 50 pages, and DOCX to 5 MB. Scanned PDFs need external OCR. The demo does not run a Java backend and its drafting rules remain simplified. Document libraries load from a version-pinned CDN when needed; document content is not uploaded. Browser PDF export now embeds bundled DejaVu Sans fonts for Turkish and a wider range of Unicode characters; Word remains the fallback for unsupported scripts. The development demo may include features newer than the latest release download. For detailed changes, see [CHANGELOG.md](CHANGELOG.md). For the release checklist, see [docs/RELEASING.md](docs/RELEASING.md). ## Requirements -- To run a release download: **Java 21**. The JAR works on Windows, macOS, and Linux; the Windows ZIP includes `Start-Doc2FAQ.cmd` and a quick-start guide. Extract the ZIP into a new folder, stop any older Doc2FAQ process, run the launcher, and open **http://localhost:8080**. Maven and Node.js are only needed to build and test from source. +- To run a release download: **Java 21 or newer**. The JAR targets Java 21 bytecode; v0.5.0's **required automated compatibility matrix is Java 21–26**. Java 27 **passed an exploratory CI build and packaged-JAR smoke test** on November 8, 2026, but is not a committed v0.5.0 support target; formal support can follow in a later release. Newer Java versions are not automatically guaranteed compatible. The JAR works on Windows, macOS, and Linux; the Windows ZIP includes `Start-Doc2FAQ.cmd` and a quick-start guide. Extract the ZIP into a new folder, stop any older Doc2FAQ process, run the launcher, and open **http://localhost:8080**. Maven and Node.js are only needed to build and test from source. To build from source: @@ -182,7 +184,7 @@ After updating your checkout to the latest `main`, run these commands from the d ```cmd mvn -B -ntp clean verify node --test src/test/js/*.test.cjs -java -jar target/doc2faq-0.5.0-SNAPSHOT.jar +java -jar target/doc2faq-0.5.0.jar ``` The JavaScript checks require Node.js. Keep the terminal open while the app runs, and use **Ctrl+C** to stop it. Open **http://localhost:8080** and refresh the browser to load the updated frontend. @@ -190,7 +192,7 @@ The JavaScript checks require Node.js. Keep the terminal open while the app runs If port 8080 is occupied, stop the previous Doc2FAQ process or use an alternate port: ```cmd -java -jar target/doc2faq-0.5.0-SNAPSHOT.jar --server.port=8081 +java -jar target/doc2faq-0.5.0.jar --server.port=8081 ``` Then open **http://localhost:8081**. Merging source changes does not update an existing JAR or a running Java process; rebuild and restart to use the fixes. Published JARs must be built from the corresponding release commit. diff --git a/docs/DESIGN-SYSTEM.md b/docs/DESIGN-SYSTEM.md new file mode 100644 index 0000000..1f1ffa8 --- /dev/null +++ b/docs/DESIGN-SYSTEM.md @@ -0,0 +1,59 @@ +# Doc2FAQ design system + +I use a light, approachable **paper-and-answers** visual style throughout +Doc2FAQ: the product homepage, browser demo, and local Java workspace. The +design keeps document processing straightforward without making the interface +feel like another generic developer tool. + +## Principles + +1. An original document mascot that gives Doc2FAQ its own identity. +2. Warm cream and cool off-white backgrounds, ink-dark outlines, offset shadows. +3. Coral for primary actions, yellow for highlights, mint for positive states. +4. Oversized, confident headings; concise, accessible helper text. +5. Direct workflow: import → generate/extract → review → export. +6. Real functionality first: responsive controls, visible keyboard focus, + sufficient text contrast, and reduced-motion support. +7. A **What's new** section that makes it clear which version is available + to download and which features are still in development. +8. Keep right-click, text selection, keyboard shortcuts, and developer tools + available. Blocking browser controls is not a security measure; sensitive + work requires proper safeguards where it is processed and stored. + +## Palette + +| Token | Hex | Usage | +| --- | --- | --- | +| Ink | `#202b34` | Text, outlines and offset shadows | +| Cool paper | `#f0f3f1` | Page background | +| Warm paper | `#fffefa` | Panels and inputs | +| Coral | `#f7a088` | Main actions and emphasis | +| Yellow | `#f8d77b` | Badges and hero art | +| Mint | `#a8d6c8` | Review and success accents | + +I maintain the homepage in `website/` and the Java app's theme in +`src/main/resources/static/retro.css`. The generated browser demo uses that +same stylesheet. HTML element IDs and JavaScript adapters must stay aligned so +that visual changes do not interrupt document import, FAQ review, or PDF/DOCX +export. + +I created Doc2FAQ's mascot and visual identity for this project. The layout +draws on illustrated, editorial-style interfaces without reusing another +product's branding, artwork, or code. + +## Local build + +```sh +node scripts/build-website.mjs +node scripts/verify-website-build.mjs +``` + +The build produces `website-dist/` with: + +- `index.html` — marketing/product homepage +- `styles.css` — homepage design tokens and components +- `demo/` — fully interactive browser demo generated from shared app sources + +I publish **the contents** of `website-dist/` to `/projects/doc2faq/` on my +portfolio website, leaving the other projects intact. Relative links allow +the homepage and demo to work from the same subdirectory. diff --git a/docs/RELEASE-NOTES-0.5.0.md b/docs/RELEASE-NOTES-0.5.0.md new file mode 100644 index 0000000..d5aefee --- /dev/null +++ b/docs/RELEASE-NOTES-0.5.0.md @@ -0,0 +1,28 @@ +# Doc2FAQ v0.5.0 — Source & Review + +I built this release to make it easier to check every answer against its source, keep track of reviewed FAQs, and export polished results. I also redesigned the interface for desktop and mobile. + +### Highlights + +- **Review status:** Mark complete FAQs as Approved, filter by review status, search the draft, and keep all entries in exports regardless of the current view. +- **Source viewer:** Inspect original passages and line references behind each answer. Editing or merging an FAQ returns it to Needs review. +- **PDF and Word:** Import PDF/DOCX, export paginated PDF or Word documents, and use PDF-first format selection. The browser demo embeds DejaVu Sans for Turkish and extended Latin characters; DOCX remains the fallback for unsupported glyphs. +- **Save and return:** Save a complete project as JSON or optionally autosave in the browser. Clear saved data has a clearly labeled confirmation and does not close the active workspace. +- **New look:** A distinctive illustrated homepage, matching Java and browser interfaces, clearer controls and responsive layouts. +- **Browser-only demo:** Try the simplified workflow online. The downloadable Java app still runs locally and may produce different FAQ suggestions. + +### Compatibility + +- Built for Java 21 bytecode; required release tests run on **Java 21–26**. +- Java 27 successfully passed exploratory build/tests and packaged-JAR smoke tests, but is not part of the formal v0.5.0 support target. +- The ZIP includes a Windows launcher. Windows SmartScreen can warn about unfamiliar unsigned scripts; direct `java -jar` startup is also supported. + +### Downloads + +- `doc2faq-0.5.0.jar` — standalone Java application. +- `Doc2FAQ-0.5.0-Windows.zip` — the same JAR plus Windows launcher and quick-start guide. +- `SHA256SUMS.txt` — hashes for both downloads. + +After starting the app, open **http://localhost:8080**. Java must remain running while the local site is in use. + +No AI service, OCR, accounts, billing, or hardened public Java backend is included. The browser demo processes document content on the visitor's device; some libraries are downloaded from a CDN. Review all generated FAQs before sharing. diff --git a/docs/RELEASING.md b/docs/RELEASING.md index e50eaa5..a4cee62 100644 --- a/docs/RELEASING.md +++ b/docs/RELEASING.md @@ -1,20 +1,28 @@ # Doc2FAQ release checklist -**Current source:** `0.5.0-SNAPSHOT`. **Latest published download:** v0.4.0. The next planned release is **v0.5.0 — Source & Review**. Merging source changes does not publish a release or update an installed JAR. Keep existing tags and assets unchanged. +**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. -## Validate the development build +## Validate the release candidate -Use JDK 21, Maven 3.6.3+, and Node.js: +Use JDK 21+, Maven 3.6.3+, and Node.js. CI compiles the application for Java 21 and runs Java tests plus a packaged-JAR smoke check on **JDKs 21 through 26**. All six required matrix jobs must succeed before publication. Java 27 is outside this **required** release matrix, but an exploratory [Java 27 CI rerun on November 8, 2026](https://github.com/OKAN-SOFTWARE/Doc2FAQ/actions/runs/42477058195) **passed the Maven build, tests, and packaged-JAR smoke check**. The earlier attempt failed only while downloading the JDK (HTTP 504). Consider formal Java 27 support separately in a later release: ```cmd mvn -B -ntp clean verify node --test src/test/js/*.test.cjs -node scripts/build-web-demo.mjs -java -jar target/doc2faq-0.5.0-SNAPSHOT.jar +node scripts/build-website.mjs +java -jar target/doc2faq-0.5.0.jar ``` Open `http://localhost:8080` (or use `--server.port=8081` if occupied). Test the packaged JAR, not only a static frontend preview: +On Linux or Git Bash, the optional automated JAR smoke check runs the packaged server locally, tests health, loads the frontend, and extracts an FAQ before stopping it: + +```sh +bash scripts/smoke-packaged-jar.sh target/doc2faq-0.5.0.jar +``` + +GitHub Actions runs this smoke check on every push/PR. On Windows without Bash, use the equivalent manual checks below. + 1. Import TXT, Markdown, PDF, and DOCX. Extract explicit questions and generate from ordinary sections; inspect exact excerpts and text-line ranges. Scanned PDFs must explain the OCR limitation. 2. Select an FAQ's source viewer and check all highlights, including multiple references after merge. Try a manual FAQ and HTML-like source text. Check desktop side-by-side and mobile stacked layouts. Typing in questions/answers must preserve page and source scroll positions. 3. Approve complete FAQs, then edit each field or merge and confirm Needs review. Blank entries cannot be approved. Move an approved FAQ and confirm approval remains. Remove/Undo restores status and references. @@ -26,11 +34,12 @@ Open `http://localhost:8080` (or use `--server.port=8081` if occupied). Test the 9. Import `TEst Data.pdf`, check the suggested `testdata-Doc2FAQ.pdf`, rename it, and verify the download. Check centered titles, PDF Lato fonts, page numbers, long answers/tokens, Unicode, and page breaks. Unsupported PDF glyphs must suggest Word. HTML must escape document markup. 10. Change source/mode, clear the document, or open another project during pending imports/drafting/exports. Old results must not replace or download current work. Check keyboard focus, mobile widths, and reduced motion. 11. Follow [WEB-DEMO.md](WEB-DEMO.md) for the separate static browser demo; verify its feature disclosure and website links. The demo cannot substitute for packaged-JAR testing. +12. Review the [Doc2FAQ design system](DESIGN-SYSTEM.md), including responsive layouts, readable focus states, reduced-motion behavior, and the **What's new** release-notes area. Confirm that an unreleased candidate is not presented as a published download. Keep browser context menus and developer tools available; browser UI restrictions are not an application security control. ## Prepare v0.5.0 1. Review and merge development changes after CI and packaged-JAR checks pass. -2. Change `pom.xml` from `0.5.0-SNAPSHOT` to `0.5.0`; date the changelog section and update README source/run commands and download links. Keep historical v0.4.0 notes accurate. Review this release-preparation change. +2. Review the release-candidate branch with `pom.xml` already at `0.5.0`. Verify the README and guide match the JAR name. Leave v0.4.0 labeled as the latest published download until v0.5.0 actually ships. Date the changelog and update download links at publication. Keep historical v0.4.0 notes accurate. 3. Update a clean checkout to the merged release commit, then build again: ```cmd @@ -40,19 +49,20 @@ Open `http://localhost:8080` (or use `--server.port=8081` if occupied). Test the git rev-parse HEAD mvn -B -ntp clean verify node --test src/test/js/*.test.cjs - node scripts/build-web-demo.mjs + node scripts/build-website.mjs java -jar target/doc2faq-0.5.0.jar ``` + On Linux or Git Bash, also run `bash scripts/smoke-packaged-jar.sh target/doc2faq-0.5.0.jar` against the clean build. The application must be stopped before the manual JAR launch, unless you specify an alternate port. + 4. Confirm a clean working tree and record the exact SHA. Repeat the packaged-JAR smoke check. Confirm that v0.5.0 does not already exist as a tag or release. ## Publish tested artifacts -1. Open [Draft a new release](https://github.com/OKAN-SOFTWARE/Doc2FAQ/releases/new). -2. Tag the exact tested commit `v0.5.0`; title **Doc2FAQ v0.5.0 — Source & Review**. -3. Copy the v0.5.0 changelog notes. Attach the tested `target/doc2faq-0.5.0.jar`, never `.jar.original` or a renamed old JAR. -4. Also attach `Doc2FAQ-0.5.0-Windows.zip` with that exact JAR, `Start-Doc2FAQ.cmd`, and a quick-start README. The launcher must reference `doc2faq-0.5.0.jar`. Include `SHA256SUMS.txt` for both downloads; remove snapshot and older-version instructions from the new bundle. -5. Review tag, commit, notes, and assets before publishing. Download the published assets separately, verify hashes and that the ZIP's JAR matches the standalone JAR, then run with Java 21. Confirm version, health, saved review status, source viewer, and PDF/Word exports. -6. Rebuild/synchronize the website demo when its shared frontend changes. Verify the actual live route and update the portfolio link if needed. +1. Merge the verified release candidate into `main`. The version-specific [release workflow](../.github/workflows/publish-v0.5.0.yml) runs on the first merge that adds it to `main`; it can also be retriggered manually using **Run workflow** after a fix. Do not create the `v0.5.0` tag or release in advance. +2. That workflow builds, tests, and smoke-tests the exact release commit on **every supported JDK (21–26)** before the publish job can start. If any matrix entry fails, publication is skipped. It then checks for an existing release/tag, builds with Java 21, runs browser tests, and assembles `doc2faq-0.5.0.jar` and `Doc2FAQ-0.5.0-Windows.zip`. The ZIP contains the **same JAR**, `Start-Doc2FAQ.cmd`, and `WINDOWS-QUICK-START.md`. It verifies the archive and writes `SHA256SUMS.txt` for both downloads. +3. **Only after every check passes**, the workflow creates the `v0.5.0` tag at the exact tested commit and publishes **Doc2FAQ v0.5.0 — Source & Review** with [release notes](RELEASE-NOTES-0.5.0.md) and all three files. If the release job fails, do not call it published; inspect the run, fix the cause, and rerun without replacing any existing tag or release. +4. Inspect the published commit, notes and assets. Download the assets independently, verify hashes and the ZIP/JAR match, then start the published JAR on Java 21. Confirm the version, health, review status, source viewer, and PDF/Word exports. +5. Date the changelog and update README and product-site release links to v0.5.0 after publication. Rebuild/synchronize the browser demo when shared frontend code changes. Verify the actual Hostinger custom-domain routes and links before calling the public website current. Accounts, billing, OCR, external AI, and public-server hardening remain separate work. The Java build is intended for local use; the static browser demo runs its simplified drafting on visitors' devices. diff --git a/docs/USER-GUIDE.md b/docs/USER-GUIDE.md index 21a7510..9436c31 100644 --- a/docs/USER-GUIDE.md +++ b/docs/USER-GUIDE.md @@ -1,6 +1,6 @@ # Doc2FAQ — Source & Review guide -This guide describes the `0.5.0-SNAPSHOT` source build. The latest published v0.4.0 download does not include the new source viewer or approval filters. See the [README](../README.md) for installation and [browser-demo comparison](WEB-DEMO.md) for the website's supported features. +This guide describes the `0.5.0` release-candidate source build, which has not yet been published. The latest published v0.4.0 download does not include the new source viewer or approval filters. See the [README](../README.md) for installation and [browser-demo comparison](WEB-DEMO.md) for the website's supported features. ## Create a draft @@ -44,7 +44,7 @@ Similar-question warnings use word overlap. Keep both retains distinct passages; The source build reads schemas 1 and 2, and saves schema 2. Older v0.4 apps reject schema-2 files. Keep an original project copy if you also use an older release. The limit remains 4 MB. -Optional browser autosave is off by default. Enabling it stores source and drafts on that browser origin. Clear saved data removes the stored copy while leaving the open workspace intact. Clear document removes source, drafts, pending results, and the saved copy. Download a project when browser storage is unavailable. +Optional browser autosave is off by default. Enabling it stores source and drafts on that browser origin. The prominently highlighted **Clear saved data** button asks for confirmation; cancel keeps the browser copy, while confirmation removes it and leaves the open workspace intact. Clear document removes source, drafts, pending results, and the saved copy. Download a project when browser storage is unavailable. ## Export diff --git a/docs/WEB-DEMO.md b/docs/WEB-DEMO.md index 57d8522..f7878fc 100644 --- a/docs/WEB-DEMO.md +++ b/docs/WEB-DEMO.md @@ -1,6 +1,6 @@ # Browser demo and website deployment -The public-facing route is `https://okantiktas.com/projects/doc2faq/`. The portfolio's existing singular convention, `/project/doc2faq/`, redirects to it. The homepage's Doc2FAQ card links to the interactive demo. +The public-facing homepage route is `https://okantiktas.com/projects/doc2faq/`. Its **interactive demo** lives at `https://okantiktas.com/projects/doc2faq/demo/`. The portfolio's existing singular convention, `/project/doc2faq/`, redirects to the product homepage. The approved light, outlined, illustrated design is documented in [DESIGN-SYSTEM.md](DESIGN-SYSTEM.md). ## What visitors can try @@ -16,9 +16,9 @@ The public-facing route is `https://okantiktas.com/projects/doc2faq/`. The portf | PDF/DOCX import and export | Yes; browser PDF.js / Word XML extraction and PDF-LIB / docx exports | Yes; PDFBox / Apache POI | | OCR, external AI, accounts/billing | No | Not implemented | -PDF and Word files are processed on the visitor's device. PDF import is limited to 5 MB, 50 pages and 50,000 extracted characters; DOCX import is limited to 5 MB, 50,000 extracted characters, 1,000 archive entries and an 8 MB expanded main XML part. Legacy `.doc`, password-protected PDFs and image-only/scanned PDFs are not supported. Word extraction reads main-document paragraphs and tables, mapping standard Heading 1–6 styles to Markdown section headings (levels 2–6) so the generator treats Heading 1 as a section rather than a document title. Headers/footers, images and complex layouts may not be retained. Browser PDF export uses Helvetica with Latin character coverage; unsupported characters produce an error recommending Word, never silently dropped text. Word exports preserve Unicode. Both exports include every FAQ regardless of filters and optionally include source references. +PDF and Word files are processed on the visitor's device. PDF import is limited to 5 MB, 50 pages and 50,000 extracted characters; DOCX import is limited to 5 MB, 50,000 extracted characters, 1,000 archive entries and an 8 MB expanded main XML part. Legacy `.doc`, password-protected PDFs and image-only/scanned PDFs are not supported. Word extraction reads main-document paragraphs and tables, mapping standard Heading 1–6 styles to Markdown section headings (levels 2–6) so the generator treats Heading 1 as a section rather than a document title. Headers/footers, images and complex layouts may not be retained. Browser PDF export **embeds bundled DejaVu Sans regular/bold font subsets** for Turkish, extended Latin, IPA and many mathematical symbols. If a font still cannot display a character, the app recommends Word rather than silently dropping it. Word exports preserve Unicode. Both exports include every FAQ regardless of filters and optionally include source references. -The demo demonstrates the review workflow; it is not a hosted Java backend and does not claim identical generation results. Its development features may be newer than the latest published JAR. No pasted text is sent to an FAQ server. Optional autosave and downloaded project files contain source text; clear saved data on shared devices. Normal website hosting still serves the page and assets. The document adapter lazily loads version-pinned PDF.js, PDF-LIB, JSZip and docx code from jsDelivr. An internet connection is needed on first use; load failures leave the workspace available for retry. See [third-party libraries](../web-demo/THIRD-PARTY.md). +The demo demonstrates the review workflow; it is not a hosted Java backend and does not claim identical generation results. Its development features may be newer than the latest published JAR. No pasted text is sent to an FAQ server. Optional autosave and downloaded project files contain source text; clear saved data on shared devices. Normal website hosting still serves the page and assets. The document adapter lazily loads version-pinned PDF.js, PDF-LIB, fontkit, JSZip and docx code from jsDelivr. DejaVu fonts are **served by the same website**, not downloaded from a third-party font service. An internet connection is needed on first use; load failures leave the workspace available for retry. See [third-party libraries](../web-demo/THIRD-PARTY.md). ## Build and keep it synchronized @@ -26,18 +26,20 @@ Run from the repository root with Node.js: ```sh node --test src/test/js/*.test.cjs -node scripts/build-web-demo.mjs +node scripts/build-website.mjs ``` -The builder creates ignored `demo-dist/` from the actual app frontend, shared project validator, stylesheet, and background. It replaces backend requests with the browser-only adapter in `web-demo/engine.js`, routes document import and binary export through `web-demo/documents.js`, keeps PDF/Word options available, uses relative asset paths with content-hash cache versions, fills the source-build version, and adds demo disclosure and homepage/source/download links. It does not modify the Java application's served UI. +The builder creates ignored `demo-dist/` from the actual app frontend, shared project validator, stylesheet, and background. It replaces backend requests with the browser-only adapter in `web-demo/engine.js`, routes document import and binary export through `web-demo/documents.js`, keeps PDF/Word options available, uses relative asset paths with content-hash cache versions, fills the source-build version, and adds demo disclosure and homepage/source/download links. The approved retro theme also styles the Java application's UI without changing its JavaScript behavior. -Copy the complete contents of `demo-dist/` into `projects/doc2faq/` in the private `OKAN-SOFTWARE/okantiktas.com` repository. Preserve relative filenames. Update the Doc2FAQ homepage card to the demo route. Keep `/project/doc2faq/index.html` as a redirect with a visible fallback link. Do not replace the rest of the portfolio or its activity scripts. +The `build-website.mjs` step then creates ignored `website-dist/` containing the approved **Doc2FAQ marketing homepage** and the working, equally styled `demo/` subdirectory. It rewrites navigation to relative URLs that are valid under `/projects/doc2faq/`. + +Copy the complete contents of **`website-dist/`** into `projects/doc2faq/` in the private `OKAN-SOFTWARE/okantiktas.com` repository. Preserve the `demo/` subdirectory and relative filenames. The Doc2FAQ homepage card may link to the new product homepage. Keep `/project/doc2faq/index.html` as a redirect with a visible fallback link. Do not replace the rest of the portfolio or its activity scripts. The portfolio is hosted through its existing GitHub-main → Hostinger deployment. Pushing source and observing a live deployment are separate steps: verify the actual custom-domain route after deployment before reporting it live. Do not deploy the full Java app to static hosting or change DNS to add this subdirectory. ## Verify before publishing -- Both demo routes resolve; homepage, source, and download links work. +- Both homepage routes and the `/projects/doc2faq/demo/` application resolve; source, download and return links work. - Examples and pasted TXT/Markdown work in both modes; text source references match exactly. - Source highlights remain stable while typing, including on mobile. - Approvals persist after save/open and optional autosave/reload; edits/merges reset approval. diff --git a/packaging/Start-Doc2FAQ.cmd b/packaging/Start-Doc2FAQ.cmd new file mode 100644 index 0000000..92265ff --- /dev/null +++ b/packaging/Start-Doc2FAQ.cmd @@ -0,0 +1,40 @@ +@echo off +setlocal +cd /d "%~dp0" +title Doc2FAQ v0.5.0 + +echo ==================================================== +echo Doc2FAQ v0.5.0 - Local Java application +echo ==================================================== +echo. +echo This window runs your local Doc2FAQ server. +echo Once it starts, open: http://localhost:8080 +echo Keep this window open while using the application. +echo. + +if not exist "doc2faq-0.5.0.jar" ( + echo ERROR: The JAR is missing. Extract the entire ZIP first. + goto :failed +) + +where java >nul 2>&1 +if errorlevel 1 ( + echo ERROR: Java was not found. + echo Install Java 21 or later and confirm "java -version" works. + goto :failed +) + +java -version +echo. +java -jar "doc2faq-0.5.0.jar" +if errorlevel 1 goto :failed +echo. +echo Doc2FAQ has stopped. +pause +exit /b 0 + +:failed +echo. +echo Startup did not complete. See WINDOWS-QUICK-START.md. +pause +exit /b 1 diff --git a/packaging/WINDOWS-QUICK-START.md b/packaging/WINDOWS-QUICK-START.md new file mode 100644 index 0000000..103ec90 --- /dev/null +++ b/packaging/WINDOWS-QUICK-START.md @@ -0,0 +1,25 @@ +# Doc2FAQ v0.5.0 — Windows quick start + +1. Extract the **entire** `Doc2FAQ-0.5.0-Windows.zip` to a folder. Do not launch it while still inside the ZIP. +2. Install Java 21–26 if needed. In Command Prompt, run `java -version` to confirm it works. The app targets Java 21 bytecode. Java 27 had an exploratory successful test but is not part of the official v0.5.0 compatibility matrix. +3. Double-click `Start-Doc2FAQ.cmd`. A terminal window explains that the app is starting and stays open while the server is running. +4. Open [http://localhost:8080](http://localhost:8080) in your browser after Java has started. +5. Close the terminal or press **Ctrl+C** when you are finished. + +If Windows blocks an unfamiliar downloaded script, do not disable Windows protections. You can instead open Command Prompt in the extracted folder and run: + +```cmd +java -jar doc2faq-0.5.0.jar +``` + +If port 8080 is already used, stop the older Doc2FAQ process or run: + +```cmd +java -jar doc2faq-0.5.0.jar --server.port=8081 +``` + +Then open [http://localhost:8081](http://localhost:8081). + +The app processes documents locally. For a browser-only demo without a Java installation, visit [the Doc2FAQ project page](https://okantiktas.com/projects/doc2faq/). + +To verify a downloaded artifact, compare its SHA-256 hash against `SHA256SUMS.txt` in the same GitHub release. diff --git a/pom.xml b/pom.xml index 2dcadeb..0ef0c07 100644 --- a/pom.xml +++ b/pom.xml @@ -11,11 +11,12 @@ com.okansoftware doc2faq - 0.5.0-SNAPSHOT + 0.5.0 Doc2FAQ Privacy-conscious document-to-FAQ preview workbench 21 + 21 diff --git a/scripts/build-web-demo.mjs b/scripts/build-web-demo.mjs index 43f5756..79bab07 100644 --- a/scripts/build-web-demo.mjs +++ b/scripts/build-web-demo.mjs @@ -1,4 +1,4 @@ -import {readFile, writeFile, mkdir, copyFile} from 'node:fs/promises'; +import {readFile, writeFile, mkdir, copyFile, cp} from 'node:fs/promises'; import {fileURLToPath} from 'node:url'; import path from 'node:path'; import {createHash} from 'node:crypto'; @@ -12,21 +12,22 @@ let html = await readFile(path.join(source, 'index.html'), 'utf8'); html = html.replaceAll('@project.version@', version) .replace('content="Doc2FAQ extracts existing Q&A or builds source-grounded FAQ suggestions from TXT, Markdown, PDF, and DOCX. Review, edit, and export."', 'content="Try Doc2FAQ in your browser: draft FAQs from text, inspect sources, edit, approve, and export."') .replaceAll('href="/styles.css"', 'href="./styles.css"') + .replaceAll('href="/retro.css"', 'href="./retro.css"') .replaceAll('src="/project.js"', 'src="./project.js"') .replace('src="/app.js"', 'src="./app.js"') .replace('src="/background.js"', 'src="./background.js"') .replace('\n \n @@ -19,14 +23,15 @@ Doc2FAQ - PREVIEW · LOCAL WORKSPACE + + LOCAL JAVA WORKSPACE
-

DOCUMENT INTELLIGENCE / PREVIEW @project.version@

-

Turn long documents into clear answers.

+

✳ WELCOME TO DOC2FAQ / @project.version@

+

LET’S TURN
PAGES INTO ANSWERS.

Extract questions already in your document or turn ordinary sections into source-grounded FAQ suggestions. Review, edit, and export your draft.

✦ No account✦ No AI calls✦ Review before sharing @@ -58,7 +63,7 @@

Turn long documents into clear answers.

Save work keeps your source and edits for later. Use Download for the finished FAQ.

- + Autosave off
@@ -99,7 +104,7 @@

Turn long documents into clear answers.

- +

Edit this name before downloading. The extension follows your chosen format.

@@ -107,14 +112,14 @@

Turn long documents into clear answers.

- +
diff --git a/src/main/resources/static/retro.css b/src/main/resources/static/retro.css new file mode 100644 index 0000000..fc9fc1a --- /dev/null +++ b/src/main/resources/static/retro.css @@ -0,0 +1,83 @@ +/* Concept skin. The existing Doc2FAQ browser engine and workflow stay intact. */ +:root{color-scheme:light;--bg:#f0f3f1;--surface:#fffefa;--surface2:#fff7e6;--line:#26333b;--muted:#5e6a72;--text:#202b34;--mint:#ec9179;--gold:#b76549;--danger:#a43232;font-family:'DM Sans',system-ui,sans-serif} +html{scroll-behavior:smooth}body{background:#f0f3f1;color:var(--text)}body::before,#ambient-background{display:none!important} +button,input,select,textarea{font-family:'DM Sans',system-ui,sans-serif}button:focus-visible,input:focus-visible,textarea:focus-visible,select:focus-visible,a:focus-visible{outline:3px solid #dc7054;outline-offset:3px} +.app-shell{max-width:1330px;padding:0 34px}.site-header{height:92px;border-bottom:3px solid var(--line);gap:20px}.brand{font-family:'Space Grotesk',sans-serif;font-size:27px;font-weight:700;letter-spacing:-.075em;color:var(--text)}.brand-mark{background:#f9d77b;color:var(--text);border:2px solid var(--line);border-radius:8px;box-shadow:3px 3px 0 var(--line);transform:rotate(-5deg)}.brand-accent{color:#e9866d} +.retro-nav{margin-left:auto;display:flex;gap:24px;align-items:center;font-size:12px;font-weight:900;letter-spacing:.02em}.retro-nav a{text-decoration:none}.retro-nav a:hover{text-decoration:underline;text-underline-offset:4px}.preview-pill{border:2px solid var(--line);border-radius:7px;background:#f8d77b;color:var(--text);font-size:10px;font-weight:900;box-shadow:3px 3px 0 var(--line)}.signal-dot{background:#6dc59b;box-shadow:none;border:1px solid var(--line)} +.hero{padding:66px 0 76px;gap:70px;grid-template-columns:1.15fr .85fr}.hero .eyebrow{color:#ad634f;font-weight:900;letter-spacing:.12em;margin-bottom:17px}.hero h1{font-family:'DM Sans',sans-serif;font-size:clamp(49px,5.5vw,80px);font-weight:900;letter-spacing:-.08em;line-height:1.06;max-width:740px}.hero h1 em{color:#df806b;font-weight:900}.hero-copy{color:#54636b;font-size:16px;line-height:1.7;margin:22px 0}.hero-chips{color:#3d4e55;font-size:12px;font-weight:700}.hero-chips span{display:inline-flex;align-items:center;background:#e0e9e4;border:1px solid #b5c4bf;padding:7px 11px;border-radius:20px} +.hero-art{border:3px solid var(--line);border-radius:12px;background:#f9d777;box-shadow:11px 12px 0 var(--line);transform:rotate(3deg);padding:25px}.art-top,.art-bottom{color:#344851}.art-skeleton{background:#d9b85f}.art-question,.art-answer{border:2px solid var(--line);border-radius:7px;background:#fffefa;color:var(--text);font-weight:700;box-shadow:3px 3px 0 #202b3423}.art-answer{background:#b4dbd0;color:var(--text)}.art-question span{background:#f9b19d;color:var(--text);border:1px solid var(--line)}.art-answer span{background:#f8e2a3;color:var(--text);border:1px solid var(--line)}.art-bottom{border-color:#9e8345}.art-bottom span:last-child{color:#344851} +.demo-links{gap:12px;margin:0 0 18px}.demo-disclosure{color:#68737c;font-size:12px}.demo-disclosure a{color:#995f4e;text-decoration:underline} +.workspace{border-top:3px solid var(--line);padding-top:44px}.workspace-heading{margin-bottom:27px}.workspace-heading .eyebrow{color:#a85e4a}.workspace h2{font-family:'DM Sans',sans-serif;font-size:35px;font-weight:900;letter-spacing:-.07em}.step-number{color:#67747a;font-weight:900} +.project-toolbar{border:2px solid var(--line);border-radius:10px;background:#fbe7b9;padding:21px;gap:12px;box-shadow:4px 5px 0 var(--line)}.project-name input,.mode-select,.export-select,.result-actions input,.review-filters select,.review-status-select,.faq-edit-question,.faq-edit-answer,.download-name-field,input#search-input,textarea{background:#fffefa;color:var(--text);border:2px solid #374751;border-radius:7px}.project-name input{min-height:42px}.project-toolbar .field-label{color:#34434c}.save-work-help,.autosave-controls,.field-help{color:#66727b}.autosave-controls input,.export-options input{accent-color:#e68b73} +.panel{border:3px solid var(--line);border-radius:12px;background:#fffefa;box-shadow:7px 8px 0 var(--line);padding:27px}.workspace-grid{gap:29px;margin-bottom:32px}.step-label{display:inline-block;background:#f5d97b;padding:6px 10px;border:2px solid var(--line);border-radius:5px;color:var(--text);font-weight:900}.panel h3{font-size:23px;font-weight:900;letter-spacing:-.055em;margin-top:14px}.panel-intro,.mode-description{color:#53636c;font-size:12px}.panel-intro code{color:#8d4f3f;background:#fcead6}.file-symbol{color:#df806b}.field-label{color:#37454d;font-weight:900}.input-meta,.source-filename{color:#66737b}textarea::placeholder{color:#8a969b} +.button{border:2px solid var(--line);border-radius:7px;padding:11px 14px;font-weight:900;box-shadow:2px 3px 0 var(--line);transition:transform .18s,box-shadow .18s}.button:not(:disabled):hover{transform:translate(1px,1px);box-shadow:1px 2px 0 var(--line)}.button-primary{background:#f69e84;color:var(--text)}.button-primary:hover{background:#ffa98e}.button-secondary{background:#fffefa;color:var(--text)}.button-secondary:hover{background:#f4e5c5}.button-quiet{color:#7f493d;box-shadow:none;border:0;background:transparent;padding:7px 8px}.button:disabled{box-shadow:none;opacity:.44}.status{color:#59666d}.status.success{color:#247554}.status.error{color:#a43232} +/* Give autosave and helper text the requested high-contrast treatment. */ +.autosave-controls,.field-help{color:#000} +/* This is a destructive browser-storage action, not a subtle text link. */ +#clear-saved-btn{display:inline-flex;align-items:center;justify-content:center;gap:10px;min-height:43px;padding:5px 5px;border:2px solid #8d3b32;border-radius:8px;background:#ffe0d9;color:#131313;font-size:12px;font-weight:900;box-shadow:3px 3px 0 #7d2d24;white-space:nowrap} +#clear-saved-btn::before{content:"✕";display:inline-grid;place-items:center;width:22px;height:22px;border-radius:50%;background:#a53932;color:#fff;font-size:13px;font-weight:900} +#clear-saved-btn:not(:disabled):hover{background:#ffc9bd;box-shadow:2px 2px 0 #8d3b32;transform:translate(1px,1px)} +.count{color:var(--text);background:#add8ca;border:2px solid var(--line);border-radius:6px;font-weight:900}.result-actions input{color:var(--text);background:#fffefa}.result-actions input:disabled{opacity:.5}.review-toolbar .button{color:#874b3f}.export-options{color:#5e6a72}.empty-state{border:2px dashed #8c9c9d;border-radius:8px;background:#f9f8f0}.empty-icon{background:#f9d779;border:2px solid var(--line);color:var(--text);box-shadow:3px 3px 0 var(--line)}.empty-state p{color:#647179} +.faq-editor,.faq-item{border:2px solid var(--line);border-radius:8px;background:#f5f8f5}.faq-editor-index{color:#925643;font-weight:900}.faq-editor .field-label{color:#3e4b52}.editor-action{background:#fffefa;color:var(--text);border:1px solid #374751;border-radius:5px}.editor-action:hover{background:#fce5bd}.editor-action.editor-remove{color:#ad3434}.faq-edit-question{font-weight:750}.faq-edit-answer{color:var(--text)}.faq-item p{color:#52616a;border-color:#bdc9c6}.faq-item summary::after{color:#e08b74} +.review-filters .field-label{color:#303e47}.source-badge{color:#8d4e33}.source-details,.similar-review{border-color:#cbd4d1}.source-details summary,.similar-review summary{color:#89513f}.source-details pre,.source-viewer-content{color:#3d4c54;background:#f2f2eb}.source-viewer{background:#f4f5ec;border:2px solid var(--line)}.source-line-number{color:#78868b}.source-line-selected{background:#bdebdc;border-color:#619c86}.source-line mark{color:#244538}.download-name-field{background:#fffefa;color:var(--text);border:2px solid var(--line)}.download-name-field input{color:var(--text)}.download-name-field span{color:#925440;border-color:#a9b5b1} +.footnote{border:2px solid var(--line);background:#e0eae3;border-radius:10px;margin:44px 0 60px}.footnote-icon{color:var(--text);border:2px solid var(--line);font-weight:900}.footnote p{color:#4f5d63}.footnote strong{color:var(--text)}.site-footer{border-top:3px solid var(--line);color:#647078;font-weight:800;padding-bottom:45px}.site-footer a{text-decoration:underline;text-underline-offset:3px} +#export-preview{background:#fffefa;color:var(--text);border:3px solid var(--line);border-radius:12px;box-shadow:9px 10px 0 var(--line)}#export-preview::backdrop{background:#23313ab3}.preview-note{color:#526069}#preview-content{border:2px solid #d6deda} +@media(max-width:1100px){.retro-nav{gap:12px}.preview-pill{font-size:9px}.hero{gap:35px}.panel{padding:22px}.workspace-grid{gap:21px}} +@media(max-width:800px){.app-shell{padding:0 22px}.site-header{height:auto;min-height:89px;flex-wrap:wrap;padding:15px 0}.preview-pill{order:3;width:100%;justify-content:center}.hero{grid-template-columns:1fr;gap:40px}.hero-art{max-width:520px}.workspace-grid{grid-template-columns:1fr}.results-list{max-height:none}} +@media(max-width:520px){.app-shell{padding:0 16px}.brand{font-size:24px}.retro-nav{font-size:10px;gap:10px}.hero{padding:52px 0}.hero h1{font-size:47px}.hero-copy{font-size:14px}.hero-art{display:none}.workspace h2{font-size:28px}.panel{padding:17px;box-shadow:4px 5px 0 var(--line)}.result-actions{display:grid;grid-template-columns:1fr 1fr}.result-actions input{grid-column:1/-1}.result-actions .export-select{grid-column:1/-1}.result-actions button{white-space:normal}.field-label{letter-spacing:.08em}.review-filters{align-items:flex-start}.review-toolbar{gap:6px}} +@media(prefers-reduced-motion:reduce){html{scroll-behavior:auto}.button{transition:none}} +/* Mobile workspace: prevent horizontal scrolling and keep every control thumb-friendly. */ +@media(max-width:650px){ + .site-header{display:grid;grid-template-columns:minmax(0,1fr);gap:12px;height:auto;padding:17px 0} + .retro-nav{margin-left:0;display:flex;justify-content:flex-start;flex-wrap:wrap;gap:12px 20px;line-height:1.5} + .retro-nav a{min-height:34px;display:inline-flex;align-items:center} + .preview-pill{order:initial;width:100%;min-height:38px;justify-content:center} + .hero h1{font-size:clamp(38px,10vw,53px);overflow-wrap:anywhere} + .hero-chips{gap:8px} + .workspace-heading{align-items:start;gap:9px} + .workspace-heading .step-number{flex-shrink:0} + .project-toolbar{display:grid;grid-template-columns:minmax(0,1fr) minmax(0,1fr);gap:12px;padding:17px} + .project-name,.save-work-help,.autosave-controls{grid-column:1/-1;min-width:0} + #save-project-btn,#open-project-btn{width:100%;min-width:0;white-space:normal} + .autosave-controls{display:grid;grid-template-columns:minmax(0,1fr);gap:11px} + .autosave-controls label{min-width:0} + #clear-saved-btn{width:100%;min-height:44px;white-space:normal} + #save-status{overflow-wrap:anywhere} + .panel,.project-toolbar,.workspace-grid{min-width:0} + .button,.editor-action,.mode-select,.export-select,.review-filters select,.review-status-select{min-height:44px} + .actions{display:grid;grid-template-columns:minmax(0,1fr) minmax(0,1fr);gap:10px} + .actions #generate-btn{grid-column:1/-1;min-width:0} + .actions #choose-file-btn,.actions #sample-btn{min-width:0;white-space:normal} + .result-actions{grid-template-columns:minmax(0,1fr) minmax(0,1fr);gap:9px} + .result-actions input,.result-actions .export-select{grid-column:1/-1;width:100%;min-width:0} + .result-actions button{min-width:0;white-space:normal;padding:10px} + .review-filters{display:grid;grid-template-columns:minmax(0,1fr) auto;gap:8px} + .review-filters .field-label{grid-column:1/-1} + .review-filters select{width:100%;min-width:0} + .review-filters .button{white-space:normal} + .review-toolbar{display:grid;grid-template-columns:minmax(0,1fr) minmax(0,1fr);gap:8px} + .review-toolbar .button{min-width:0;white-space:normal} + .export-options{align-items:stretch;flex-direction:column;gap:10px} + .export-options .button{width:100%} + .faq-editor{padding:12px} + .faq-editor-heading{display:grid;grid-template-columns:minmax(0,1fr);gap:10px} + .faq-editor-actions{flex-wrap:wrap;gap:7px} + .editor-action{min-height:42px} + .source-viewer{min-width:0} + .input-meta{gap:8px;flex-wrap:wrap} + #export-preview{width:calc(100% - 20px);padding:15px} + #preview-content{padding:14px} + input[type=text],input[type=search],select,textarea{font-size:16px} +} +@media(max-width:370px){ + .app-shell{padding:0 12px} + .brand{font-size:22px} + .panel{padding:14px} + .panel-top{gap:8px} + .hero h1{font-size:36px} + .workspace h2{font-size:clamp(25px,8vw,28px)} + .review-toolbar{grid-template-columns:minmax(0,1fr)} + .review-toolbar .button{width:100%} + .input-meta{font-size:10px} +} + diff --git a/src/test/js/app-state.test.cjs b/src/test/js/app-state.test.cjs index 12a2b3c..512a9d9 100644 --- a/src/test/js/app-state.test.cjs +++ b/src/test/js/app-state.test.cjs @@ -6,7 +6,7 @@ const assert = require("node:assert/strict"); const tools = require("../../main/resources/static/project.js"); const script = readFileSync(path.resolve(__dirname, "../../main/resources/static/app.js"), "utf8"); -function harness(saved = new Map(), blocked = false, fetcher = null) { +function harness(saved = new Map(), blocked = false, fetcher = null, confirmer = () => true) { const elements = new Map(); function node(tag = "") { return {tag, value: "", checked: false, disabled: false, children: [], handlers: {}, textContent: "", @@ -26,7 +26,7 @@ function harness(saved = new Map(), blocked = false, fetcher = null) { removeItem(key) { if (blocked) throw new Error("Storage blocked"); saved.delete(key); } }; const context = {Doc2FaqProject: tools, document: {getElementById: element, createElement: node}, - FormData: class { append() {} }, localStorage: storage, setTimeout(fn) { fn(); return 1; }, clearTimeout() {}, confirm: () => true, + FormData: class { append() {} }, localStorage: storage, setTimeout(fn) { fn(); return 1; }, clearTimeout() {}, confirm: confirmer, fetch: fetcher || (async () => ({ok: true, json: async () => ({items: [{question: "Where is support?", answer: "Ask the team.", source: {section: "Support", startLine: 1, endLine: 2, excerpt: "Q: Where is support?\nA: Ask the team."}}]})}))}; vm.runInNewContext(script, context); @@ -75,6 +75,18 @@ test("disabling autosave removes stored text and the preference", async () => { assert.equal(app.element("faq-count").textContent, "1 ITEM"); }); +test("canceling Clear saved data preserves the browser copy and current work", async () => { + const app = harness(new Map(), false, null, () => false); + await makeDraft(app); + app.element("autosave-toggle").checked = true; + app.element("autosave-toggle").handlers.change(); + assert.equal(app.saved.has("doc2faq.project.v1"), true); + app.element("clear-saved-btn").handlers.click(); + assert.equal(app.saved.has("doc2faq.project.v1"), true); + assert.equal(app.saved.get("doc2faq.autosave"), "true"); + assert.equal(app.element("faq-count").textContent, "1 ITEM"); +}); + test("blocked storage and an invalid saved project leave the app usable", async () => { const app = harness(new Map(), true); await makeDraft(app); app.element("autosave-toggle").checked = true; app.element("autosave-toggle").handlers.change(); diff --git a/src/test/js/app-ui.test.cjs b/src/test/js/app-ui.test.cjs index c62ac0d..066885f 100644 --- a/src/test/js/app-ui.test.cjs +++ b/src/test/js/app-ui.test.cjs @@ -7,6 +7,17 @@ const vm = require("node:vm"); const scriptPath = path.resolve(__dirname, "../../main/resources/static/app.js"); const source = readFileSync(scriptPath, "utf8"); +test("PDF and Word are the first two export choices, with PDF selected by default", () => { + const html = readFileSync(path.resolve(__dirname, "../../main/resources/static/index.html"), "utf8"); + const menu = html.match(/