Skip to content

feat: prepare Doc2FAQ v0.4.0 — Review, Save & Export - #11

Merged
OKAN-SOFTWARE merged 2 commits into
mainfrom
feature/0.4.0-review-save-export
Oct 29, 2026
Merged

OKAN-SOFTWARE merged 2 commits into
mainfrom
feature/0.4.0-review-save-export

Conversation

@OKAN-SOFTWARE

@OKAN-SOFTWARE OKAN-SOFTWARE commented Oct 29, 2026 •

Copy link
Copy Markdown
Owner

Doc2FAQ v0.3.1 loses unsaved drafts on reload and exports only text formats. This adds a complete local workflow for saving work, checking answers against the source, reviewing similar questions, and downloading PDF or Word documents.

Changes

  • Save and reopen validated, versioned project files with source text, title, FAQ order, edits, original excerpts, and review choices. Add optional browser autosave/restore and clear saved data.
  • Return exact source excerpts with extracted-text line ranges in both drafting modes. Keep excerpts visible while editing and mark changed questions/answers for rechecking.
  • Retain distinct answers for repeated topics. Add similar-question flags, keep/merge controls, and undo for removals/merges; merging preserves both answers and references.
  • Add validated, stateless PDF/DOCX export endpoints with embedded PDF fonts, metadata, page numbers, and optional source labels. Add content preview and configurable titles for all five export formats.
  • Add cursor-responsive ambient particles/glow with reduced-motion support. Clarify Document title and Save work, and add Clear document that removes the saved source and discards pending results.
  • Derive download names from the uploaded file (e.g. TEst Data.pdf → testdata-Doc2FAQ.pdf) and let users rename the output; preserve that choice in saved work and use it in export response headers.
  • Center the PDF/Word title, omit the FAQ-count subtitle, and use embedded Lato fonts for PDF.
  • Update the README, changelog, and release checklist. Use 0.4.0-SNAPSHOT for the development build.

Validation

  • mvn -B -ntp clean verify: 50 Java tests passed.
  • node --test src/test/js/*.test.cjs: 36 JavaScript tests passed.
  • Packaged-JAR browser walkthrough in headless Chromium: generate/edit, source excerpts, question-edit-to-remove interaction, merge/keep/undo, project download/reopen, autosave/reload/clear, preview, and all five downloads. Desktop and 390 px layouts checked; no browser script errors.
  • PDF and DOCX downloads rendered and visually inspected with short and five-page samples. Checked Unicode text, page numbers, margins, final-answer retention, and optional references.
  • Remote source tree matches the locally tested tree: 5b36f0d290faec0cded90176674df808499a3355.

Notes

Source references identify lines in the extracted text, rather than original PDF pages. PDF export reports unsupported font glyphs and offers DOCX as an alternative. Snapshot undo clears after a later FAQ edit/addition/reorder/review choice so it cannot overwrite newer work.

Release preparation and publishing the versioned JAR follow docs/RELEASING.md.

@OKAN-SOFTWARE
OKAN-SOFTWARE merged commit 55da725 into main Oct 29, 2026
2 checks passed
@OKAN-SOFTWARE
OKAN-SOFTWARE deleted the feature/0.4.0-review-save-export branch October 29, 2026 18:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant