docs: replace broken install snippets in README + docs#46
Merged
Conversation
Caught during a final pre-send audit. The CDN snippet pointed at `https://eats.travisfixes.com/v1.js`, which returns 401 (the worker only serves API routes). The npm snippet pointed at `@travisbreaks/travisEATSbugs`, which is not on the public npm registry (the README's own Status line correctly states "Public npm publish lands at v1.0.0", so the snippet contradicted itself). This PR replaces both with paths that actually work today, mirroring the fix that just landed on the marketing site: - **README.md** Install section: script tag pointing at the travismakes.org bundle that the live demo uses, plus a vendor-from- repo path. Includes the canonical wiring snippet (`LocalStorageAdapter` + `AnnotationPageMode` + `init({ onToggle })`). - **docs/install.md** fully rewritten. Four options (script tag, vendor bundle, pnpm pack, self-hosted worker) with a picking-guide table at the bottom. Honest note about `eats.travisfixes.com` being a not-public-signup destination today; public hosted tier lands in the `teb-cloud` repo per the strategic plan. - **docs/architecture.md** Widget Delivery section: same swap; the `eats.travisfixes.com/v1.js` route is correctly framed as a v1.0 deliverable, not a present-tense claim. `client-facing-tenancy.md` line 239 still mentions `eats.travisfixes.com/v1.js` but that file is a design doc for the multi-tenant Phase 2 work and correctly describes future state. No change needed there. No code or schema change. Tests + lint untouched. Em-dash gate green. Co-Authored-By: Tadao <tadao@travisfixes.com>
travisbreaks
added a commit
that referenced
this pull request
May 20, 2026
* docs: replace broken install snippets in README + docs Caught during a final pre-send audit. The CDN snippet pointed at `https://eats.travisfixes.com/v1.js`, which returns 401 (the worker only serves API routes). The npm snippet pointed at `@travisbreaks/travisEATSbugs`, which is not on the public npm registry (the README's own Status line correctly states "Public npm publish lands at v1.0.0", so the snippet contradicted itself). This PR replaces both with paths that actually work today, mirroring the fix that just landed on the marketing site: - **README.md** Install section: script tag pointing at the travismakes.org bundle that the live demo uses, plus a vendor-from- repo path. Includes the canonical wiring snippet (`LocalStorageAdapter` + `AnnotationPageMode` + `init({ onToggle })`). - **docs/install.md** fully rewritten. Four options (script tag, vendor bundle, pnpm pack, self-hosted worker) with a picking-guide table at the bottom. Honest note about `eats.travisfixes.com` being a not-public-signup destination today; public hosted tier lands in the `teb-cloud` repo per the strategic plan. - **docs/architecture.md** Widget Delivery section: same swap; the `eats.travisfixes.com/v1.js` route is correctly framed as a v1.0 deliverable, not a present-tense claim. `client-facing-tenancy.md` line 239 still mentions `eats.travisfixes.com/v1.js` but that file is a design doc for the multi-tenant Phase 2 work and correctly describes future state. No change needed there. No code or schema change. Tests + lint untouched. Em-dash gate green. Co-Authored-By: Tadao <tadao@travisfixes.com> * chore(memory): record colleague-send polish sprint in thread-state Captures today's late-day work (post-Phase-1 sprint EOD wrap): - PR #37 / #38 / #39 / #46 merged on TEB repo - v0.0.10-alpha.0 release tagged + GitHub Release published - 10 shipped roadmap issues closed with version pointers - Dependabot merge train (#27-#30) merged; #31-#32 auto-closed by dependabot when ungrouping landed; #40-#44 closed with tracking issue #45 opened for major dep migrations - CODE-side PR #231 merged + deployed (TEB marketing refresh + travisfixes.com em-dash sweep) - GitHub profile README slimmed (Featured Projects + Stats + Stack cut; bio + 4 destination badges kept) - Colleague-send (Adam Masonbrink + Rikard Arkebaeck at timeglass.ai) shipped after a final pre-send audit caught broken install snippets in the README and docs that would have looked bad to a CEO-level reader. Memory note for future-self: pre-send audits must sweep README + docs alongside marketing surfaces. The same broken install URL was in four places and fixing one is not fixing the rest. Co-Authored-By: Tadao <tadao@travisfixes.com> --------- Co-authored-by: Tadao <tadao@travisfixes.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Caught during a final pre-send audit pass. The README and two docs files promise install paths that don't exist:
README.mdInstall<script src="https://eats.travisfixes.com/v1.js" ...>README.mdInstallpnpm add @travisbreaks/travisEATSbugsdocs/install.mdOption 1/v1.jsURLdocs/install.mdOption 2pnpm adddocs/install.md"Getting a project token"eats.travisfixes.com"docs/architecture.mdWidget Delivery/v1.jsandpnpm addsnippetsThe README's own Status line already states "Public npm publish lands at v1.0.0", so the snippet block on the same page contradicted it. Same logic for the CDN: an honest pre-1.0 framing exists at the marketing-site level after today's marketing refresh; the README needed the same treatment.
Changes
LocalStorageAdapter+AnnotationPageMode+init({ onToggle }).eats.travisfixes.comis not a public signup destination today; the hosted tier lands in the futureteb-cloudrepo.What this does NOT touch
docs/client-facing-tenancy.mdline 239 still referenceseats.travisfixes.com/v1.jsbut that file is the Phase 2 multi-tenant design doc; its present-tense-sounding "Worker serves both..." sentence is in a clearly future-state planning section. No change needed.Verification
grep -rPn '\x{2014}'returns no matches).https://travismakes.org/travis-eats-bugs/widget.jsreturns 200 withcontent-type: application/javascriptand serves the IIFE bundle (verified via curl just now).Test plan