bitvid/docs/README.md

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.
• 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 devLogger vs userLogger and 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.