gitea-admin/gh-christianlouis-docuelevate
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: add comprehensive documentation for storage reorganization

Browse Source 
- Create StorageArchitecture.md with detailed architecture explanation
- Document collision handling with -0001 suffix format
- Explain immutable original and processed file storage
- Document forced Cloud OCR reprocessing feature
- Update API.md with new reprocess-with-cloud-ocr endpoint
- Update UserGuide.md with user-facing feature descriptions
- Include database schema, lifecycle diagrams, and examples

Co-authored-by: christianlouis <361235+christianlouis@users.noreply.github.com>
This commit is contained in:
copilot-swe-agent[bot]
2026-02-11 20:14:56 +00:00
parent 952e27b339
commit c7dff41492
3 changed files with 338 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/UserGuide.md
+12 -1
View File
@@ -115,6 +115,12 @@ View the complete processing history with a timeline showing:
- Network connectivity was lost during processing
- Configuration has been updated and you want to reprocess with new settings
**Force Cloud OCR**: For files with low-quality embedded text, you can use the "Reprocess with Cloud OCR" option to force high-quality Azure Document Intelligence OCR processing, even if the PDF already contains embedded text. This is useful when:
- The embedded text quality is poor or contains errors
- OCR accuracy needs to be improved
- The embedded text is corrupted or garbled
- You need the highest quality text extraction possible
#### Process Flow Visualization
The process flow visualization shows a visual representation of the document processing pipeline:
- **Green indicators**: Successful stages
@@ -128,7 +134,7 @@ This helps you understand:
#### File Previews
If your file is still available on disk, you can preview it directly in the browser:
- **Original File**: The file as it was uploaded
- **Original File**: The immutable original file as it was first ingested
- **Processed File**: The file after metadata has been embedded (if processing completed)
Both previews support:
@@ -136,6 +142,11 @@ Both previews support:
- Opening in a new tab for full-screen viewing
- Side-by-side comparison of original and processed versions
**Note**: The original file is stored in an immutable archive and is never modified. This ensures you always have access to the file exactly as it was uploaded, which is valuable for:
- Auditing and compliance
- Debugging processing issues
- Reprocessing with improved algorithms
## Document Processing Features
Depending on the system configuration, DocuElevate can perform: