thePR0M3TH3AN/bitvid
1
0 Fork 0
mirror of https://github.com/PR0M3TH3AN/bitvid.git synced 2026-10-27 07:52:24 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #2357 from PR0M3TH3AN/ai/docs-update-20250222-10909080055527982820

Browse Source 
Update Documentation: Quickstart and Typo Fix
This commit is contained in:
thePR0M3TH3AN authored and GitHub committed 2026-02-11 09:54:17 -05:00
2 parents c140ba82c3 5f7d1e4457
commit 89d26c9d2f
2 files changed
+3 -3
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

AGENTS.md
+1 -1
View File
@@ -4,7 +4,7 @@ This guide tells AI agents how to keep bitvid aligned with the current product d
**Important:** Before starting any development or debugging, please review `KNOWN_ISSUES.md`. This file documents pre-existing test failures, environmental quirks, and architectural limitations that you should be aware of to avoid unnecessary investigation.
For any nostr related work, please review the nip documentation located in /docs/nips before begining work.
For any nostr related work, please review the nip documentation located in /docs/nips before beginning work.
**Comment publishing guardrail:** Session actors are limited to passive telemetry (e.g., view counters). Always require the logged-in Nostr signer when sending video comments through [`js/nostr/commentEvents.js`](js/nostr/commentEvents.js). See the reminder in [`docs/nostr-event-schemas.md`](docs/nostr-event-schemas.md#event-catalogue) for context.
README.md
+2 -2
View File
@@ -165,9 +165,9 @@ To run **bitvid** locally:
_(Note: The default port is 3000, but `npx serve` may select a different port if 3000 is in use. Check your terminal output.)_
_Note: If you prefer manual steps, run `npm run build` followed by `npx serve dist`, then open the root URL printed by `serve` (for example `http://localhost:3000/`). Because `dist` is the document root in this mode, always open `/` rather than appending `/dist`._
_Note: If you prefer manual steps, run `npm run build` followed by `npx serve dist` (or `cd dist && python3 -m http.server 3000`), then open the root URL printed by the server (for example `http://localhost:3000/`). Because `dist` is the document root in this mode, always open `/` rather than appending `/dist`._
_If you use a static server from the repository root (for example VS Code Live Server), open `http://127.0.0.1:5500/dist/` with the trailing slash. `http://127.0.0.1:5500/dist` (no trailing slash) can resolve incorrectly depending on server routing._
_If you use a static server from the repository root (for example VS Code Live Server or `python3 -m http.server`), open `http://127.0.0.1:8000/dist/` with the trailing slash. `http://127.0.0.1:8000/dist` (no trailing slash) can resolve incorrectly depending on server routing._
_Optional: Add a local rewrite/redirect rule from `/dist` → `/dist/` so manual local testing always lands on the correct path._