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

オープン
#472 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

難易度
5/5
見積もり時間
1週間以上
初心者へのやさしさ
35/100
issue の種類
機能追加
明瞭さ
おおむね明確
活発さ
活発
技術スタック
typescript

調査の方向性

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.

索引モデルが issue の本文から書いたものです。

説明

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.
主要言語
TypeScript
スター
1
フォーク
0
PR マージ指標
30日以内にマージされた PR はありません

環境構築

このプロジェクトには開発コンテナ、Dockerfile、コントリビューションガイドがありません。まず README を読み、一般的な手順ははじめてのコントリビューションガイドを参照してください。

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

patricktree/cup のほかの issue

patricktree/cup の issue をすべて見る

似ている issue

TypeScript の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。