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

Updates to docs. Added new transcription_methodology, revised approach to revisions: 1 revision per document (that can be updated)

Browse Source
This commit is contained in:
Jim Lancaster
2026-07-29 13:29:44 -05:00
parent ec61013b47
commit eaf9805121
6 changed files with 77 additions and 45 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/ver1/ver1.md
+5 -7
View File
@@ -34,12 +34,12 @@ V1 is complete when all of the following are true:
1. Confirm and document invariants:
- `Job.text` is original immutable transcription output.
- `Revision` is optional and user-authored.
- Revisions may derive from original `Job.text` or a previous revision.
- Revisions are derived from the original `Job.text`.
2. Verify relationship cardinality assumptions:
- `Document` -> many `Source`
- `Document` -> many `Job`
- `Source` -> one `Job`
- `Source` -> many `Revision`
- `Source` -> one `Revision`
3. Ensure field naming consistency (`date_created`, `date_updated`, `date_uploaded`) across code and docs.
4. Freeze V1 status lifecycle to current implementation (`queued`, `processing`, `transcribed`, `failed`).
@@ -83,11 +83,9 @@ V1 is complete when all of the following are true:
### Tasks
1. Update job detail and related UI components:
- Display original immutable transcription from `Job.text`.
- Display optional revisions sourced from `Source.revisions`.
2. Replace legacy terminology in UI copy:
- “transcript history” -> “revision history” where appropriate.
3. Align date fields with new schema naming.
4. Preserve clear user messaging when no revisions exist.
- Display optional revision sourced from `Source.revisions`.
2. Align date fields with new schema naming.
3. Preserve clear user messaging when no revisions exist.
### Deliverables
- Updated jobs page and detail components.