mirror of
https://github.com/PR0M3TH3AN/bitvid.git
synced 2026-10-27 07:52:24 +00:00
Documentation Index
Welcome to the bitvid documentation. This directory contains detailed architectural guides, API references, and system overviews.
Core Systems
- BitUnlock Permission Layer: Architecture and phased plan for purchases, rentals, creator memberships, platform subscriptions, bundles, events, and short-lived playback authorization using BitUnlock as BitVid's permission layer.
- 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.
Active plans
- Performance & Efficiency Plan: A measurement-first staged plan for reducing client CPU, memory, and network work without degrading Nostr discovery, feed freshness, moderation, or playback. Tracked as TODO #34.
- BitUnlock Permission-Layer TODO: Ordered implementation checklist for the BitUnlock-backed media permission and subscription work.
For more details on contributing, please see CONTRIBUTING.md.