docs(ai): update quickstart and contributing (agent)

Co-authored-by: PR0M3TH3AN <[email protected]>
This commit is contained in:
google-labs-jules[bot]andPR0M3TH3AN committed 2026-02-10 14:09:05 +00:00
1 parent d3277be3ea
commit de7218d90b
3 files changed
+39 -2

No files matched your search

+35
View File
@@ -0,0 +1,35 @@
# Documentation Index
Welcome to the bitvid documentation. This directory contains detailed architectural guides, API references, and system overviews.
## Core Systems
- **[Application Coordinators](./app-coordinators.md)**: Overview of the coordinator pattern used to manage app-wide state and services.
- **[Authentication Architecture](./auth-architecture.md)**: How session management, login flows, and signer integration work.
- **[Feed Engine](./feed-engine.md)**: The pipeline for fetching, filtering, scoring, and sorting video feeds.
- **[Playback & Fallback](./playback-fallback.md)**: The URL-first playback strategy with WebTorrent fallback orchestration.
- **[Watch History System](./watch-history-system.md)**: Encrypted watch history synchronization and storage.
## Nostr Protocol
- **[Nostr Event Schemas](./nostr-event-schemas.md)**: The definitive catalogue of all Nostr event kinds and data structures used by bitvid.
- **[DM Privacy Model](./dm-privacy-model.md)**: How Direct Messages are handled, including NIP-17 relays and privacy controls.
- **[NIP-46 Client Overview](./nip46-client-overview.md)**: Details on the NIP-46 remote signer implementation.
## Moderation & Safety
- **[Moderation Service](./moderation-service-overview.md)**: How content moderation, reporting, and admin lists function.
- **[Logging Strategy](./logging.md)**: Guidelines for using `devLogger` vs `userLogger` and production logging policies.
## Design & UI
- **[Design System](./design-system.md)**: Guide to the token-based design system and CSS architecture.
- **[Menus & Popovers](./menus.md)**: Documentation for the menu and popover system.
## Operations
- **[Instance Configuration](./instance-config.md)**: Guide to configuring a bitvid instance.
- **[Deployment Notes](./deployment-notes.md)**: Notes and checklists for deploying bitvid.
- **[Manual QA Checklist](./qa.md)**: The standard manual QA script for releases.
For more details on contributing, please see [CONTRIBUTING.md](../CONTRIBUTING.md).