Docs/fix stale references and env example#42
Conversation
Bhasvanth-Dev9380
left a comment
There was a problem hiding this comment.
Thanks for this, @Ranjithsingh2004 — stale-reference rot is exactly the kind of thing that goes unnoticed, so this is appreciated. I checked every change against the current tree; most of it is spot-on. A few things to sort before merge. 🦁
✅ Verified correct
- pi SDK references (
@mariozechner/pi-*→@earendil-works/pi-*,0.73.1→0.79.9) inAGENTS.md,skills/coding-agent/SKILL.md, and therun-main.tscomment — genuinely stale, correct fix. This is the valuable core of the PR. - README channels (adding Slack / Discord / iMessage / BlueBubbles) — confirmed accurate: all six are registered in
src/agents/channels/bundled-channel-metas.tsand have full implementations (slack 37, discord 57, imessage 27, bluebubbles 41.tsfiles). The README really was stale. AGENTS.mdF:\Brigade\→brigade/— good catch; removes an absolute path thatAGENTS.mditself forbids..env.example— 8 of the 9 vars verified present insrc/(BRIGADE_MODE,FORCE_MODE,STRICT_MODE,ENCRYPTION_KEY/_OLD/_FILE,CONVEX_URL,ENABLE_INBOX_PERSIST).media-path-guard.tsadditions (encryption.key,admin-key.txt,.convex-data) — correct filenames (admin-key.txtmatchesconvex-cmd.ts;encryption.keymatches the other guards) and a genuine security hardening. Nice.
🔧 Please address before merge
1. Two code changes inside a "docs" PR.
src/core/server.ts and src/security/media-path-guard.ts are code, not docs.
- The
media-path-guard.tsdenylist additions are a real security improvement 👍 — but they (and theserver.tsedit) would be better as a separatefix(security): …PR so history and review focus stay clean. src/core/server.tsremoves"0.0.0.0/loopback-only"fromLOCALHOST_BINDS. I verified it's inert — that exact string is never passed as a host anywhere (only prose comments elsewhere mention "loopback-only") — so it's harmless. But it's an undocumented behavioral-set edit with no test or rationale; please either call it out explicitly or drop it.
2. BRIGADE_HOST_ENV is itself stale.
The new .env.example block documents BRIGADE_HOST_ENV, but it exists nowhere in src/ — only in README.md. So this documents a non-functional variable. Please either wire it up or remove it from both .env.example and README.md. (It pre-existed in the README, so not introduced here — but a stale-reference pass is the right place to catch it.)
3. Fill the PR template + confirm CI.
The template is blank and the checklist is unticked. Since this touches src/, please confirm npm run typecheck, npm test, and npm run build are green, select the change type, and complete the checklist.
Once the above is sorted I'm happy to merge — thanks again for the cleanup!
1f33a93 to
881ed05
Compare
…vider UX Corrections to three recently-merged contributor PRs: - Redactor (#65): the AQ. Google-key rule had been added only to the cron redactor, so the sessions_history transcript path still leaked AQ./AIza keys. Add both Google-key rules to agents/tools/sessions/shared.ts (the real leak path), and tighten the cron pattern with a negative lookbehind so dotted identifiers (com.AQ.x, /AQ.x, token.AQ.x) are no longer over-redacted. Fix the stale "used by sessions_history" header comment. - BRIGADE_HOST_ENV (#42): the documented operator override was never wired. Wire it as a DISPLAY-ONLY host-tag override in the system-prompt runtime line; process.platform stays the real value so behavioural branching (Windows shell hygiene) is unaffected. Restore the .env.example + README docs. - Custom-provider onboarding (#63): the invalid-URL error never rendered (a silent re-prompt) — fixed with the lastError pattern. Extract routesToCustomProvider so the test asserts the real gate, not a re-implemented copy. New tests cover the redactor (both paths + false-positive guards) and the host-tag override.
Summary
Related issues
Type of change
fix— bug fixfeat— new featuredocs— documentation onlyrefactor/perf/test/chore/ciChecklist
npm run typecheckpassesnpm testpassesnpm run buildcompilesNotes for reviewers