mirror of
https://github.com/PR0M3TH3AN/bitvid.git
synced 2026-10-27 16:02:26 +00:00
Shorts: - Status now "decisions locked"; intro lists the real scope (exclusion + publish). - Remove stale "candidate signals / confirm in Phase 0" preamble (D4 locked). - Fix inaccuracy: native shorts are kind-30078 + isShort, not kind-22. - Moderation section says locked + notes the NSFW no-autoplay rule. - Rewrite Risks to the locked decisions: main-feed-exclusion regression risk, native-marker-must-round-trip risk, WebTorrent-swarm-storm on autoplay, search scope sub-decision. Drop the now-inverted double-listing/aspect-ratio risks. Live: - Status "decisions locked"; scope reads read→post chat + host zaps. - Config flags corrected: introduces FEATURE_LIVE_INGEST *and* FEATURE_LIVE_CHAT_POST (Phase 3b); "two flags" footprint fixed; chat-post UI gated on both. - Phase 0 now "confirm field mapping + default relays + zap target" (not "lock decisions", already locked). - Moderation: read-chat WoT-mute filtering + post-chat rate/stance as design items. - Add risks: high-volume chat buffering, planned/scheduled streams, multiple streaming renditions, private/token-gated streams. Zap-target resolution noted. 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.