What does Cup store with each conversion so its narration document can be rendered again?

Open
#485 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
25/100
Issue type
Feature
Clarity
Needs clarification
Activity status
Active
Tech stack
typescript
Domain
backend

Research direction

Start by reviewing the existing audiobook.json storage layout and the research on keeping full publisher pages mentioned in the issue. Decide which conversion artifacts to retain, how R2 keys and size limits work, and how deletion handles them; define what happens when a page exceeds its limit. Done means these storage and lifecycle decisions are settled, including whether fetched HTML is kept.

Written by the indexing model from the issue text.

Description

wayfinder:grilling

Question

Which objects does preparation store per conversion so the narration document can be rendered on request: the fetched page HTML, the selected HTML, the synchronization units (as now)? Decide R2 key layout next to audiobook.json, size limits and what happens when a page exceeds them, how deletion covers them, and whether the fetched page is kept at all given the research on keeping full publisher pages.

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.