docs: update README and docs for verbatim-only refine (#86)#88
Merged
Conversation
Reflect the removal of the standard/caption refine modes (v1.1.0): README feature list, docs/user-guide Refine section, docs/api refine_mode parameter + prompt-mode list, and docs/architecture module/schema notes. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Contributor
There was a problem hiding this comment.
Pull request overview
Updates project documentation to match the post-#86/#87 behavior where LLM refine is verbatim-only (preserves timestamps and segmentation), removing references to the previously documented standard/caption modes.
Changes:
- README (EN/JA): feature list updated to describe verbatim-only refine.
- User guide: “Refine Modes” section collapsed into a single “Refine” section describing verbatim behavior and custom prompt settings.
- API + architecture docs: update
refine_modedocumentation to reflect verbatim-only support and legacy-mode rejection/normalization notes.
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| README.md | Updates feature bullet to verbatim-only refine wording. |
| README.ja.md | Mirrors README refine wording update in Japanese. |
| docs/user-guide.md | Reworks refine documentation to a single verbatim-only refine section and updates prompt-settings wording. |
| docs/api.md | Updates create-job example and refine_mode parameter / refine-prompts mode docs to verbatim-only. |
| docs/architecture.md | Updates module description and Job schema row for refine_mode to verbatim-only/legacy behavior. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| - Fixes only misrecognized words, proper nouns, and technical terms | ||
| - **Preserves all filler words**: "um", "uh", "えー", "あのー" | ||
| - **Preserves timestamps and segment boundaries**, so the SRT stays aligned with the audio | ||
| - Does not change sentence boundaries or punctuation |
| - Improves punctuation | ||
| - Preserves segment boundaries | ||
| - Best for: general transcription, interviews, podcasts | ||
| > Earlier versions also offered `standard` and `caption` modes, but they shifted the SRT timing — `caption` re-segmented and redistributed timestamps, and `standard` dropped fillers and could desync the displayed text from the audio — so they were removed in v1.1.0. Jobs created before then are read back as `verbatim`. |
| | quiz | JSON String? | Cached quiz results | | ||
| | enable_refine | Boolean | LLM post-processing enabled | | ||
| | refine_mode | String? | verbatim / standard / caption | | ||
| | refine_mode | String? | verbatim (legacy standard/caption normalized to verbatim) | |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Documentation follow-up to #86 / #87, which consolidated the refine post-processing to verbatim-only but did not update the docs. This brings README and
docs/in line with the shipped behavior.Changes
standard/captionwere removed in v1.1.0; updated the Settings → Refine Prompts wording.refine_modeparameter and the refine-prompts mode list now reflect verbatim-only (and thatstandard/captionreturn 400INVALID_REFINE_MODE).refine_moderow updated.Docs-only — no code or tests touched.
🤖 Generated with Claude Code