mirror of
https://github.com/PR0M3TH3AN/bitvid.git
synced 2026-10-27 07:52:24 +00:00
thePR0M3TH3ANandClaude Opus 4.8
a2050ccd50
Expands live-publish-plan Phase 7 into docs/bitvid-bridge-plan.md: a super-simple Windows/macOS/Linux app that makes going live turnkey. Core design: native media core (MediaMTX + FFmpeg + rclone; never sees the Nostr key) + an embedded bitvid "Studio" webview that signs — talking over in-app IPC, NOT browser->localhost (dodges mixed-content/PNA and keeps signing in the web layer, honoring "BitVid signs; Bridge routes"). Surfaced 10 decisions: framework (Wails/Go vs Tauri), control model (embedded webview vs website-drives-localhost), capture vs receive, webview signer support (NIP-46 + encrypted nsec), ingest protocols (RTMP MVP), upload (bundled rclone), one-codebase-two-modes (Bridge desktop == self-hosted Media Node headless), pass-through-only transcode, code-signing/notarization ownership (the real cost of "easy install"), license/telemetry. Phases 0-7 (shell+core -> receive MVP -> record/VOD -> restream -> turnkey/packaging -> built-in capture -> SRT/WHIP/WebRTC -> headless node + BitVid Box), invariants, packaging/signing, risks, sources. Linked from the publish plan. 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.