docs: V3-first rewrite of README + SKILL.md frontmatter#15
Merged
Conversation
The previous README was V2-shaped with a V3 section bolted on top. This rewrite leads with V3 — the actual current state — and treats the V2 details as legacy reference. README.md - Opens with the one-line value proposition and an ASCII pipeline diagram so a first-time reader sees what this is in 5 seconds - "60 秒上手" / quick install / Whisper-engine-per-platform table - V3 core capabilities laid out as cards with file links + docs links - Daily workflow block with full env-var template - Test commands per module - Tutorial index pointing at prompts 15-18 as the recommended entry - Platform support matrix with Whisper engine + encoder per OS - Architecture: every script with one-line job + [V3] marker for new ones - Linux GPU configuration trimmed to essentials SKILL.md - Frontmatter description rewritten to mention every V3 capability so the AI agent introspecting this skill knows what it covers (content guard, story engine, audience profiles, auto-enrich, multi-platform export, caption generator, internal-token guard) - Body opens with the V3 pipeline diagram + the script reference table + the new render_final flag table + the day58 lesson → V3 default mapping table - V2 reference content preserved below the new V3 section .gitignore - Adds NOTES.local.md / *.local.md / .notes/ so personal scratch never reaches the public repo
5 tasks
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.
Why
The previous README was V2-shaped with a "🆕 V3" section bolted on top. The body still walked through V2 commands as the canonical workflow. A reader landing on this repo would assume
transcribe.py → split → merge → renderwas the path, and only find V3 if they scrolled past the install section.This rewrite leads with V3 — the actual current state of the skill — and treats V2 as legacy reference.
What changed
README.md[V3]marker on new onesSKILL.md.gitignoreNOTES.local.md/*.local.md/.notes/so personal scratch never reaches the public repoTests
131/131 still passing — no logic changes, docs only.
Test plan
pytest tests/greendocs/prompts/15-...,scripts/...)git statusdoes not show NOTES.local.md after creating one