Repository navigation
Releases: OKAN-SOFTWARE/Doc2FAQ
Release list
Doc2FAQ v0.3.1 — Parsing and Draft Reliability Fixes
Changelog
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.3.1
Fixed
- Avoid excessive regex backtracking on whitespace-heavy input in both FAQ modes.
- Discard pending draft results and errors after the source, example, imported text, or mode changes.
- Preserve separate client and provider responsibility suggestions while still filtering duplicates for the same party.
Changed
- Replaced the document placeholder with neutral Q&A prompts and the Generate Mode sample with a team knowledge guide, removing payment and fee examples from the interface.
- Added instructions for rebuilding and restarting the versioned JAR, handling occupied ports, and publishing the matching release artifact.
0.3.0
Added
- Extract Mode for existing Markdown question headings and explicit Q:/A: pairs.
- Generate Mode for source-grounded FAQ suggestions from document sections. Generation is local and deterministic, not powered by a paid AI provider.
- In-browser FAQ editor for changing questions and answers, reordering items, removing duplicates, and adding new entries.
- Markdown, JSON, and standalone HTML exports, with HTML content escaped for safety.
- Windows Command Prompt instructions for installing Java 21 and Maven, configuring PATH, and troubleshooting local startup.
- Java service and API integration tests for generation, limits, and validation, plus Node tests for export safety.
Improved
- Expanded FAQ text validation to 50,000 characters, consistent with extraction and the browser.
- Generate Mode filters common-topic duplicates, document-title headings, and existing FAQ appendices.
- More natural question phrasing for client responsibilities, confidentiality, and intellectual-property ownership.
- Existing Extract Mode behavior remains unchanged when a document contains explicit FAQ pairs.
Supported inputs and limits
- TXT and Markdown uploads in the browser (256 KB file size).
- PDF and DOCX uploads via the Java server (5 MB each).
- Maximum 50 PDF pages, 50,000 extracted characters, and 30 FAQ items.
Known limitations
- Scanned or image-only PDFs require OCR before import; OCR is not included.
- Generate Mode is heuristic and may skip useful details or produce generic questions. Review every answer.
- No accounts, paid plans, public-server hardening, or document persistence are included.
- PDF and DOCX export are planned for a future release. The current outputs are Markdown, JSON, and HTML.
0.2.0
- Added PDF and DOCX text import using Apache PDFBox and Apache POI.
- Introduced format-signature validation and explicit errors for unsupported, empty, encrypted, or scanned documents.
- Added document upload size and page/text extraction limits.
- Preserved local, deterministic explicit-Q&A extraction.
Doc2FAQ v0.3.0 — Generate Mode, Review & Multi-Format Export
Doc2FAQ v0.3.0
Doc2FAQ v0.3.0 introduces a more flexible, review-first document-to-FAQ workflow with two processing modes, editable FAQ drafts, and multiple export formats.
What's New
Extract Mode
- Extract existing questions and answers from documents.
- Preserve the original source information.
Generate Mode
- Create source-grounded FAQ suggestions from ordinary document sections.
- Filter duplicate questions and irrelevant document headings.
- Improve question phrasing for common topics, including responsibilities, confidentiality, and ownership.
FAQ Editor
- Edit questions and answers.
- Reorder, remove, and manually add FAQ entries.
- Review content before sharing.
Export Options
- Markdown
- JSON
- HTML
Additional Improvements
- Consistent 50,000-character text limit.
- PDF and DOCX document import.
- Improved input validation and error handling.
- Expanded automated tests.
- Updated documentation with Windows CMD installation instructions for Java 21 and Maven.
Requirements
- Java 21
- Apache Maven 3.6.3 or later
Important Notes
FAQ generation uses deterministic, source-grounded rules. It does not require an external AI provider or API key.
Scanned PDFs require OCR, which is not included in this release.
PDF and DOCX export, user accounts, and subscription features are planned for future development.
Project
Developed by Okan Tiktas.
Copyright © 2026 Okan Tiktas.
Licensed under the MIT License.
Doc2FAQ v0.2.0 — PDF & DOCX Support
Merge pull request #3 from OKAN-SOFTWARE/feature/pdf-docx-import-v0.2 feat: support PDF and DOCX imports in Doc2FAQ v0.2