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

Open
#472 0 comments 0 reactions 0 assignees View on GitHub

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

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

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.
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

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from patricktree/cup

All issues in patricktree/cup

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.