Glossary-only change; no code touched. Charting the admin dashboard map (#114) settled four terms the glossary did not carry: - **Orphan Series** (#125) — a Series no Reader bookmarks; a state of the Series, never a Lifecycle bucket. - **Lane Pass** (#117) — one sweep of a Poll Lane, including a pass that declined to work and why. - **Forced Poll** (#119, #120) — a Poll the owner asks for by marking the Series, which jumps the waiting rules but never the Site's refusal, and which may replace a Cover. - **Paused Lane** (#119) — a bounded, restart-surviving stop on one Site, distinct from the deploy-time kill switch. **Acquisition** is amended in the same pass: establishing a Cover is no longer unique to it, since a Forced Poll can replace one. Reviewed-on: #128 Co-authored-by: Sulthan Zaki <sultankiki05@gmail.com> Co-committed-by: Sulthan Zaki <sultankiki05@gmail.com>
7.3 KiB
Bookmark Manager
Read-progress tracker for serialised fiction. A reader browses third-party manga and novel sites; userscripts capture where they got to and sync it to a self-hosted backend, so progress survives across sites and devices.
Language
Series: One ongoing work — a manga or a novel — as published by a Site. Identified by the canonical slug the Site itself publishes for it, never by its title and never by a Chapter Slug. A Series exists once and is shared by every Reader who bookmarks it; it owns the facts that are true regardless of who is reading — title, cover, Latest Chapter. A Reader cannot change them; they describe the Series, not anyone's relationship to it. Avoid: manga, title, book, comic
Site: One third-party source a Series is published on. A Series on two Sites is two Series. Avoid: source, host, provider, domain
Chapter Slug: A slug a Site builds its chapter addresses from. Not an identity: one Series may have several, any of them may differ from the slug that identifies the Series, and none is computable from another. Only the Site's own links say which ones a Series uses, so a Chapter Slug is always discovered, never derived. Avoid: series slug, url slug, permalink, chapter path
Cover: The image that stands for a Series wherever it is listed. A fact about the Series like its title — one Cover per Series, shared by every Reader, never per-Reader. Defined by what a Reader's browser can display, not by where the Site keeps the picture: an address no client can load is not a Cover, it is a missing one. Avoid: thumbnail, poster, image URL, artwork
Reader: A person with their own Progress. Exactly one per set of credentials, so there is no separate "account" concept to model — the credential belongs to the Reader. Avoid: user, account, member, subscriber
Bookmark: One Reader's tracked relationship with one Series, holding only what differs between Readers: Progress, Favourite, Lifecycle bucket. Facts about the Series itself belong to the Series, not here. Avoid: entry, item, record, subscription
Orphan Series: A Series no Reader bookmarks. Removing a Bookmark never removes the Series, so the row outlives every relationship to it: nothing reads it, no Poll visits it, and it still owns a Cover. A state of the Series, not a Lifecycle bucket — it says how many Readers hold it, never anything about a Reader. Avoid: dangling, unused, dead series, stale
Library:
One of the two halves of the collection — manga or novel — selected by a Bookmark's
kind. The web UI and the userscripts each address exactly one Library at a time.
Not a per-person concept: "everything one person has bookmarked" is a different idea
and must not be called a Library.
Avoid: section, tab, category
Progress: The furthest chapter a reader has actually read in a Series. Only a change in Progress is real activity, so only Progress reorders the list. Avoid: position, bookmark (the noun is taken), last read
Latest Chapter: The highest-numbered chapter a Site has published for a Series. The number is what ranks it, never a date and never the Site's own "newest chapter" banner — where a Site disagrees with itself, its list of chapters is the record and its summary of that list is not. Established by a Poll and, between Polls, by a Sighting. Distinct from Progress in every way that matters: it is a fact about the Site, not about the reader, and it must never reorder the list. Avoid: newest, current chapter, update
Poll: The backend's own check of a Site for a Series's Latest Chapter, made without the Reader present. Performed once per Series no matter how many Readers bookmarked it — a Poll is work done on behalf of the Series, never on behalf of a Reader. Avoid: scrape, refresh, check, sync
Poll Lane: One Site's own stream of Polls, carrying the pace at which that Site is willing to be asked. Every Site has exactly one and no Lane can slow, block or borrow from another's; a Reader never has one and never influences one. Avoid: worker, queue, scheduler, batch, wave
Lane Pass: One sweep of a Poll Lane over the Series due on its Site: what it found waiting, how many it read, and whether it declined to work at all. A fact about the Lane rather than about any Series — a pass that read nothing is still a pass, and one that declined carries the reason it declined, since a Lane resting and a Lane stuck look identical from a count alone. Its record outlives the process that made it: "the poller has done nothing for six hours" is only answerable by something written down. Avoid: run, cycle, tick, batch, poll history
Forced Poll: A Poll the owner asks for by hand instead of waiting for the Series's turn. It jumps its Lane's queue and ignores every waiting rule — the rest between Polls, a Sighting standing in for a check, a Series only finished Readers hold — but never overrules a Site that is refusing us, the Lane's spacing between fetches, or a Series with no page to fetch. Asked for by marking the Series, never by commanding the poller, so it happens on the Lane's next pass rather than at the moment of asking. It also takes whatever Cover the Site publishes today: asking for one is asking to accept the page as it now stands, so it is the only read after Acquisition that can replace a Cover. Avoid: manual poll, refresh, retry, force refresh
Paused Lane: A Poll Lane the owner has stopped for a bounded time. It makes no Polls until the pause expires, so its Series stay due and unstamped exactly as they do when a Site cannot be reached. Every pause carries an expiry — a Lane cannot be stopped indefinitely — and it outlives a restart, being a fact about the Site rather than about the running process. Avoid: disabled, off, stopped, suspended, kill switch (that is the deploy-time switch)
Sighting: What a Reader's browser happened to see of a Series's Latest Chapter while that Reader was on the page. It reports the same fact as a Poll but carries none of its authority: a Poll always overrules it, and only a Sighting on a Series no Reader else holds may defer one. A Sighting a later Poll contradicts downwards is a false Sighting, and enough of those cost the Reader the right to defer at all. Avoid: client report, user poll, observation, claim
Acquisition: The single read of a Series page made the moment the Series first exists, giving it both its Latest Chapter and its Cover without waiting for the Lane's pace. Distinct from a Poll in the two ways that matter: a Reader is present — it is triggered by their first Bookmark of that Series — and it establishes a Cover rather than refreshing facts, which no Poll does unless the owner forces one. It happens once in a Series's life; every later read of the same page is a Poll. Avoid: initial poll, first fetch, prefetch, warm-up
New Chapter: The state where Latest Chapter is ahead of Progress. The single condition the ember accent is permitted to signal. Avoid: unread, update available
Lifecycle bucket: Which of three mutually exclusive states a Bookmark sits in — reading, archived, or finished. A Bookmark is in exactly one. Orthogonal to being a favourite. Avoid: state, status (as a domain word), list
Favourite: A reader's manual pin on a Bookmark. Orthogonal to the Lifecycle bucket, and never a reason to reorder the list. Avoid: starred, pinned, priority