bbchops/transcription
1
0
Fork 0
generated from john/python-template
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Used co-pilot for complete review of all documentation, including extensive revision of v1.md

Browse Source
This commit is contained in:
Jim Lancaster
2026-07-02 12:37:32 -05:00
parent 97cb7055d4
commit ec61013b47
17 changed files with 155 additions and 2894 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/index.md
+6 -9
View File
@@ -4,9 +4,7 @@ This project is a production application for transcribing and preserving histori
## Start Here
Read [architecture.md](architecture.md) first.
Then review [ver1/ver1.md](ver1/ver1.md) for completion scope and [ver1/ver1-step1-results.md](ver1/ver1-step1-results.md) for current architecture-consolidation status.
Read [architecture.md](architecture.md) first, then review [ver1/ver1.md](ver1/ver1.md).
The architecture page is the primary technical reference and defines:
@@ -17,14 +15,15 @@ The architecture page is the primary technical reference and defines:
## What The Application Does
At a high level, users upload images or pdfs as sources of handwritten, typed, or typeset documents, run asynchronous transcription jobs, review and edit transcript revisions, and search across accepted text.
At a high level, users upload images or PDFs as content sources for handwritten, typed, or typeset documents, run asynchronous transcription jobs, review optional revisions, and search across accepted text.
Core capabilities:
- document upload and metadata capture
- document grouping with one or more content sources and metadata capture
- asynchronous transcription with visible job status
- immutable original transcription persisted with each job (plus provider/model/prompt metadata)
- transcription prompt management with one Markdown file per prompt for human refinement over time
- revision history for transcript edits
- optional revision history for user-authored edits (from original text or prior revisions)
- full-text search over accepted transcripts
- export of transcript data
@@ -43,12 +42,10 @@ This operating model keeps deployment and maintenance simple while preserving cl
- Architecture and technical design: [architecture.md](architecture.md)
- Version 1 implementation plan: [ver1/ver1.md](ver1/ver1.md)
- Version 1 Step 1 plan: [ver1/ver1-step1.md](ver1/ver1-step1.md)
- Version 1 Step 1 results: [ver1/ver1-step1-results.md](ver1/ver1-step1-results.md)
- Architecture decision records (ADR index): [adr/README.md](adr/README.md)
- Runtime and deployment requirements: [requirements.md](requirements.md)
- Error handling policy and operational guidance: [error_handling.md](error_handling.md)
- Domain context and transcription policy: [intent.md](intent.md)
- Domain context and transcription policy: [Intent.md](Intent.md)
## Glossary