From 5f7d1e4457647207102ed42c0109b5a673c52e51 Mon Sep 17 00:00:00 2001 From: "google-labs-jules[bot]" <161369871+google-labs-jules[bot]@users.noreply.github.com> Date: Wed, 11 Feb 2026 14:39:48 +0000 Subject: [PATCH] docs(ai): update quickstart and contributing (agent) Co-authored-by: PR0M3TH3AN <53631862+PR0M3TH3AN@users.noreply.github.com> --- AGENTS.md | 2 +- README.md | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/AGENTS.md b/AGENTS.md index 7c5aa755..994617e6 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -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. diff --git a/README.md b/README.md index 14b75c49..ca3a3177 100644 --- a/README.md +++ b/README.md @@ -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._