Map: decide what the narration document shows and render it on request
Nobody has claimed this yet.
Assessment
- Difficulty
- 5/5
- Estimated time
- Over a week
- Newbie friendliness
- 35/100
- Issue type
- Feature
- Clarity
- Mostly clear
- Activity status
- Active
- Tech stack
- typescript
- Domain
- backend-api-design, web-dev
Research direction
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.
Written by the indexing model from the issue text.
Description
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
hrefpoints atcup.audio, and they get notarget/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 inaudiobook.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
narrationTextnever 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:
grillinganddomain-modelingfor HITL tickets,prototypefor prototype tickets,researchfor 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
- What does narration document creation do today with tables, preformatted text, rules, description lists and figures?: only
p, headings,blockquoteand lists keep structure; every table cell,dtandddbecomes its own bare-punit,precollapses whitespace,hrvanishes, andfigure(withfooter) is deleted with its content before AI selection even runs; a heading before a container merges into its first unit. - May Cup keep the full fetched publisher page with each conversion?: no exception clearly covers either copy (not legal advice); the selected HTML adds little beyond the sanitized article Cup already keeps, while the full page adds scripts, comments and personal data and is what publisher terms forbid; recommends the selected HTML for the conversion lifetime and the full page only briefly (e.g. 30 days or failed preparations), stripped, never served, never shared between listeners.
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.
- Dominant language
- TypeScript
- Stars
- 1
- Forks
- 0
- PR merge metrics
- No merged PRs in 30d
Getting set up
This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from patricktree/cup
-
wayfinder:grilling
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
patricktree/cup#484 ·
-
wayfinder:grilling
Difficulty 2/5 1-3 hours Newbie friendliness 48/100
patricktree/cup#487 ·
-
wayfinder:grilling
Difficulty 5/5 Over a week Newbie friendliness 25/100
patricktree/cup#486 ·
-
wayfinder:grilling
Difficulty 5/5 Over a week Newbie friendliness 25/100
patricktree/cup#485 ·
-
wayfinder:grilling
Difficulty 5/5 Over a week Newbie friendliness 25/100
patricktree/cup#483 ·
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
vercel-labs/ui#865 ·
Maintainers usually reply within 1 day
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 63/100
outline/outline#14638 · 1 comment ·
Maintainers usually reply within 1 day
-
bot:ai-assisted component:platform-js status:untriaged
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
midnightntwrk/platform-js#69 ·
Maintainers usually reply within 1 day
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 67/100
Maintainers usually reply within 1 day