mirror of
https://github.com/PR0M3TH3AN/bitvid.git
synced 2026-10-27 16:02:26 +00:00
google-labs-jules[bot]andPR0M3TH3AN
e5949af2e8
Executed content-audit-agent. Audited content/docs/guides/upload-content.md against code. Added technical details about multipart uploads and troubleshooting steps. Co-authored-by: PR0M3TH3AN <[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.
- 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.
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.