mirror of
https://github.com/PR0M3TH3AN/bitvid.git
synced 2026-11-02 10:52:27 +00:00
thePR0M3TH3ANandClaude Opus 4.8
01545056af
live-publish-plan: - Expand the config-flags section into a full enumerated "off = no trace" list: every Go-Live surface (Studio/entry points, My Videos Live sub-tab, live-event builders, Bridge/session UI, restream UI, archive->VOD flow, routes) is absent when FEATURE_LIVE_PUBLISH is off. Bridge/restream have their own sub-flags. - Clarify watch/publish independence (an instance can allow watching without broadcasting). - New gap closed: WHO may go live — publishing should respect the whitelist/WoT (operators can restrict broadcasting to whitelisted creators; don't be an open ingest relay). bitvid-bridge-plan: - Invariant 6: the Bridge respects the connected instance's config (embedded webview inherits FEATURE_LIVE_PUBLISH; go-live degrades gracefully when off). - Invariant 7: bind local ingest to loopback (127.0.0.1) only; auth required for any wider bind. Matching risks added. - Architecture: Studio webview loads the instance's deployed web app (remote, cached) so it auto-inherits instance flags and never drifts; instance URL configurable. 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.