Guide, handbook and README say what the release train does

Aperta
  • Qualcosa non va?
#382 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
2/5
Tempo stimato
1-3 ore
Idoneità per principianti
55/100
Tipo di issue
Documentazione
Chiarezza
Specificata chiaramente
Stato di attività
Attiva
Stack tecnologico
html, javascript, markdown, python
Ambito
documentation, testing

Direzione di ricerca

Start with the copy edits at site/guide/index.html around lines 68, 86 and 115, site/handbook/index.html line 41, and README.md lines 80-81. Check each replacement against DemoScenesView.swift:226-227 and LiveDictationDelivery.swift:112-126 before editing. Run node --test tests/*.test.mjs from site/ and python3 scripts/test-read-retirement.py to confirm. Done when the new assertions pass and the grep for 'Neural voices' and 'Dictate, Read,' returns nothing.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

bug

Outcome: Guide, handbook and README say what the release train does.

Verified by an independent skeptic against the release train head d7cea35 (round four of the 15–16 October pass: energy, leaks, first run, keyboard, concurrency, settings propagation, public docs).

Guide, handbook and README say what the train does: full-display sharing for Draw, the Timer and a floating persona, words copied when live insertion stops, the Timer keeping the display awake, and no Read

What a person sees: A presenter who follows the guide shares only the Workbench window. Mid-demo, Draw marks, the break Timer and a floating persona never reach the audience, though the app's Present footer now warns about this. Someone whose live dictation stopped mid-sentence reads that insertion just stops, assumes the rest is lost and dictates it again, though the full words are already copied. A host who wants the screen awake during a break reaches for caffeinate, though the Timer now holds it. On GitHub and the public handbook, Read and a 'Neural voices' download still appear as live, while the README and the guide both say Read is retired, so an agent using the handbook's entry-point list starts from a tool that does not exist.

Evidence (d7cea35): site/guide/index.html:115: '…press Present and share the Workbench window in your call.' with no caveat; the app's footer says 'Share the Workbench presentation window in your call; to include Draw, the Timer or a floating persona, share your entire display.' (DemoScenesView.swift:226-227, #372). The guide's own tiles invite the combination: Draw 'over whatever is on screen … Timer live here too' (:86) and Persona 'floating over any app' (:91). site/guide/index.html:68 ends 'Moving or editing the field stops live insertion.'; LiveDictationDelivery.swift:112-126 copies the words whatever Restore clipboard says when the writer stopped ('Copied.' or '…the complete transcript is copied and saved in History'). The Timer holds .idleDisplaySleepDisabled while a countdown shows and for 300 s after Time is up (AppCoordinator.swift:104-116), as recorded in workbench.md:207; the guide's Draw tile says only 'Whiteboard and Timer live here too.' (:86). site/handbook/index.html:41 says 'Dictate, Read, Draw and Present remain direct entry points.'; README.md:80 credits Pocket TTS as 'Downloaded only when someone chooses Neural voices.' and :81 'installed macOS voices'. Both contradict README.md:63 and site/guide/index.html:99 ('Read text-to-speech is retired'). grep -rniE 'tts|kyutai|pocket' Sources finds nothing, and AVSpeechSynthesizer appears only in the check mode PersonaVoiceNativeCheck.swift.

Change: 1. site/guide/index.html:115. After "press Present and share the Workbench window in your call." add: "To include Draw, the Timer or a floating persona, share your entire display instead." This matches DemoScenesView.swift:226-227 and doesn't claim a window share never includes them.
2. site/guide/index.html:68. Replace "Moving or editing the field stops live insertion." with "Moving or editing the field stops live insertion, and the complete words are copied, ready to paste."
3. No Timer sentence in the Draw tile at :86.
4. site/handbook/index.html:41. "Dictate, Read, Draw and Present remain direct entry points." becomes "Dictate, Draw and Present remain direct entry points."
5. README.md:80. Keep the credit but make it truthful, for example: "…CC BY 4.0. It powered the retired Read voices; current builds neither include nor download it." Or delete the bullet if the maintainer prefers. Optionally make README.md:81 "Apple AppKit, SwiftUI and AVFoundation." (AVSpeechSynthesizer appears only in the PersonaVoiceNativeCheck check mode.)
6. Checks.

  • Site: add a separate test in site/tests/updates.test.mjs or a new site/tests/copy.test.mjs. It reads only ../guide/index.html and ../handbook/index.html, requires 'share your entire display' and 'complete words are copied' in the guide, and forbids 'Dictate, Read,' in the handbook template.
  • README: add the check to scripts/test-read-retirement.py, asserting that README.md doesn't contain 'Neural voices'.
  • No site test may read README.md or Sources: the Vercel build gets only site/ and runs these tests.

Acceptance: 1. From site/, node --test tests/*.test.mjs passes. The new guide and handbook assertions fail when run against d7cea35's site/guide/index.html and site/handbook/index.html.
2. node build.mjs still builds from site/ alone, with no test reading outside site/. A quick proof: copy site/ to a scratch directory and run the tests there.
3. python3 scripts/test-read-retirement.py passes, and its new README assertion fails against d7cea35's README.md.
4. grep -nE "Neural voices|Dictate, Read," README.md site/handbook/index.html returns nothing.
5. grep -n "share your entire display" site/guide/index.html hits inside #phone-share, the section the app's Help online ↗ opens.

Value: 2 of 5 · Grammar: Quality · Risk: Very low for the copy itself. The real risk is in the proposed check: a site test that reads ../../README.md or ../Sources would pass locally but fail the Vercel build, which uploads only site/ and runs the site tests, and so block the production site deploy at release. Keep the README assertion in scripts/test-read-retirement.py. Minor: removing the Pocket TTS bullet entirely drops a historical CC BY credit, so rewording it is the safer default.

Refs #287

Build-ready record from round four of the overnight lead pass, verified by an independent skeptic per item. Closes only after native acceptance.

Lingua principale
Swift
Stelle
0
Fork
1
Merge medio
18h 19m
PR unite (30g)
114

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di Ship-Work/workbench

Tutte le issue di Ship-Work/workbench

Issue simili

Altre issue su Swift

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.