Map: decide what the narration document shows and render it on request

Aperta
#472 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
5/5
Tempo stimato
Più di una settimana
Idoneità per principianti
35/100
Tipo di issue
Funzionalità
Chiarezza
Abbastanza chiara
Stato di attività
Attiva
Stack tecnologico
typescript

Direzione di ricerca

Read libs/narration-document-creation/src/narration-document-creation.ts and the linked ADRs 0001 and 0014, then review docs/architecture/r2-storage.md and docs/architecture/conversion.md. Define storage and request-time rendering while preserving synchronization unit boundaries, IDs, and narration text; specify presentation rules for links, inline markup, and block elements. Done means a GitHub spec is ready for /to-tickets, with the wiki pages and ADR to follow when the build lands.

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

Descrizione

wayfinder:map

Destination

A spec on GitHub, ready for /to-tickets, for (a) storing the fetched page and the selected HTML with each conversion, (b) a request-time renderer that turns the selected HTML into the narration document's presentation HTML while reproducing the stored synchronization units exactly, and (c) the chosen presentation rules (links, inline markup, block elements). The ADR and the wiki pages (docs/architecture/r2-storage.md, docs/architecture/conversion.md, the glossary's narration document) follow when the build lands.

Notes

  • Origin: Linear CUP-52. The operator's trigger is that the narration document renders links today: they look clickable but are covered by the reader's invisible "play segment" button once the track is ready, a relative href points at cup.audio, and they get no target/rel. Whether to keep links at all is open.
  • Today: createNarrationDocument (libs/narration-document-creation/src/narration-document-creation.ts) sanitizes the AI-selected HTML once during preparation; only the sanitized HTML and the synchronization units land in audiobook.json. The fetched page and the selected HTML live only in expiring Workflow step results.
  • Invariant: synchronization unit boundaries, unit IDs and each unit's narrationText never change after preparation, since each unit has its own paid audio segment. Everything else about presentation should be free to change.
  • Only the web app reads the narration document (the mobile apps are shells around it); the HTML reaches the reader through the listener API.
  • Related ADRs: 0001 (one canonical synchronized audiobook), 0014 (cut the source material at the visible headline, source subtitle in the narration document).
  • Skills: grilling and domain-modeling for HITL tickets, prototype for prototype tickets, research for research tickets. Use the glossary's terms (narration document, synchronization unit, segment, narration block, source material).
  • Paid probes (a few real conversions) are fine; prefer fixtures where they suffice and report the spend.

Decisions so far

Not yet specified

  • How the reader styles the markup that is kept (link styling, code, emphasis) once the inline-markup and links decisions are made.
  • How the spec stages the build: storage change first or renderer first, and what ships together.

Out of scope

  • Images in the narration document: they stay with Linear CUP-82, which builds on this map's renderer. The renderer must merely not rule them out.
  • Backfilling existing conversions by re-running AI selection: their fetched pages and selected HTML are gone, and a re-run could change the narrated units and their paid audio. Existing conversions get only what can be rendered from the HTML they already store.
Lingua principale
TypeScript
Stelle
1
Fork
0
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Preparare l'ambiente

Questo progetto non fornisce container di sviluppo, Dockerfile né guida per i contributori, quindi l'ambiente è a tuo carico: parti dal suo README e consulta la nostra guida al primo contributo per i passaggi generali.

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 patricktree/cup

Tutte le issue di patricktree/cup

Issue simili

Altre issue su TypeScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.