docs: refresh README + API.md + CLAUDE.md for final submission - #64
Merged
Merged
Conversation
Demo recording is up next, so: - README test count refreshed from 227 → 318 to match current pytest output. Demo video script rewritten to walk through the features added since the original outline: first-visit autorun, scene-level AI polish, manual speaker dropdown, five-format export, Editor → Adapt back-sync. - New "亮点速览" section in README so a grader scanning the top half of the page hits the differentiators (AI + rule fallback, network stability stack, structured logging, multi-format export, dual-track editor) without needing to read the test matrix. - New API.md sections for the two endpoints shipped this sprint: POST /api/v1/refine/scene (scene-level mode refine) and POST /api/v1/export (Fountain/txt/md renderer). Both follow the same code+message+errors detail shape as the existing endpoints so frontend error handlers don't need a special case. - README repo-structure tree updated to list the new modules (export/, llm/transport.py, llm/parse_utils.py, llm/logging.py, data/sample-novel.ts, screenplay-patch.ts) and logs/ runtime dir. - CLAUDE.md scope sentence extended to acknowledge the editor and export features that were "out of scope" originally but landed in the v1 cut. - .gitignore extended to swallow ad-hoc novel*.txt / image*.png test artifacts dropped at the repo root during smoke-testing so graders cloning fresh don't see them. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
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
1 participant
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.
功能描述
录像前文档收尾：让 README 顶部、API 端点列表、CLAUDE.md 项目范围都对齐当前 main 状态。
实现思路
README：
`docs/API.md`：
CLAUDE.md：scope 句子调整——"frontend editor"和"export"原本是 out-of-scope，现在已经发货，更新为 in-scope。
.gitignore：吞掉根目录的 `novel*.txt` / `image*.png` 测试残留，评委 fresh clone 不会看到。
测试方式
依赖与复用声明
无新增第三方依赖。纯文档 + .gitignore 调整。
Co-Authored-By: Claude Opus 4.7 (1M context) noreply@anthropic.com