mirror of
https://github.com/PR0M3TH3AN/bitvid.git
synced 2026-10-27 07:52:24 +00:00
thePR0M3TH3ANandClaude Opus 4.8
18d4d29616
Third live/short plan, sequenced after #16 (ingest) + #16b (shorts). Turns the maintainer's BitVid Live design into a repo-accurate, convention-aligned plan: - Core decision: Nostr-native control layer, NOT a hosting backend. Static client stays static (signs, no keys, no server); the one thing a browser can't do (receive/route live media) is isolated in an OPTIONAL server-side Media Node/Bridge (MediaMTX). External-provider-only mode (Phase 1) needs zero infra. - Cross-linked to docs/live-ingest-plan.md (#16): the watch side (Live tab, player, chat, zaps, hls.js) is a dependency and reused; this doc adds the builders + Studio + Media Node/Bridge. Shared Phase 0 schema in nostrEventSchemas. - Verified against real code: NIP-98 HTTP-Auth (kind 27235) builder exists for bridge auth; s-tag + js/utils/storagePointer.js -> .info.json is exactly how archive->VOD maps (ended stream becomes an ordinary kind-30078 video + 34235 mirror); canonical video kind 30078. - Decisions surfaced: hosting model, signing-during-stream (tab-open vs NIP-46), pass-through vs transcode, WebRTC scope, local Bridge scope, flag reconciliation (FEATURE_LIVE_INGEST/PUBLISH/BRIDGE/RESTREAM). - 9 phases (0 flags+schema → 1 external-provider no-infra → 2 mock bridge → 3 Media Node MVP → 4 recording/VOD → 5 restream → 6 OBS companion → 7 local Bridge → 8 WebRTC), 5 engineering-rule invariants, risks, sources. Co-Authored-By: Claude Opus 4.8 <[email protected]>
Documentation Index
Welcome to the bitvid documentation. This directory contains detailed architectural guides, API references, and system overviews.
Core Systems
- Application Coordinators: Overview of the coordinator pattern used to manage app-wide state and services.
- Data-Flow Refactor — Dev Plan & Spec: The incremental plan to put all subsystems on a shared, governed relay/data foundation (SubscriptionManager, stores, unidirectional flow).
- Known Bugs (deferred): Confirmed defects/limitations found during the refactor, queued to fix later.
- Feed Algorithm ↔ Lists Audit: Read-only audit of whether the For You feed is actually driven by the user's follows/hashtags/watch-history, with the gaps and a fix order.
- Authentication Architecture: How session management, login flows, and signer integration work.
- Feed Engine: The pipeline for fetching, filtering, scoring, and sorting video feeds.
- Playback & Fallback: The URL-first playback strategy with WebTorrent fallback orchestration.
- Watch History System: Encrypted watch history synchronization and storage.
Nostr Protocol
- Nostr Event Schemas: The definitive catalogue of all Nostr event kinds and data structures used by bitvid.
- DM Privacy Model: How Direct Messages are handled, including NIP-17 relays and privacy controls.
- NIP-46 Client Overview: Details on the NIP-46 remote signer implementation.
- Batch-Capable nip-07 Extension Proposal: Exploratory design for a signer extension that parallelizes bulk decryption (DMs, watch history) without exposing keys.
Moderation & Safety
- Moderation Service: How content moderation, reporting, and admin lists function.
- Logging Strategy: Guidelines for using
devLoggervsuserLoggerand production logging policies.
Design & UI
- Design System: Guide to the token-based design system and CSS architecture.
- Menus & Popovers: Documentation for the menu and popover system.
Operations
- Instance Configuration: Guide to configuring a bitvid instance.
- Deployment Notes: Notes and checklists for deploying bitvid.
- Manual QA Checklist: The standard manual QA script for releases.
For more details on contributing, please see CONTRIBUTING.md.