Skip to content

docs: drop stale tally / v0.0.0 / broken-install refs in README + 11 doc pages#6

Merged
petrpan26 merged 5 commits into
mainfrom
fix/readme-and-doc-stale-refs
May 7, 2026
Merged

docs: drop stale tally / v0.0.0 / broken-install refs in README + 11 doc pages#6
petrpan26 merged 5 commits into
mainfrom
fix/readme-and-doc-stale-refs

Conversation

@petrpan26
Copy link
Copy Markdown
Contributor

@petrpan26 petrpan26 commented May 7, 2026

Three cleanups

README quickstart pointed at install paths that don't work pre-tag:

  • `brew install beava-dev/beava/beava` — formula doesn't exist until v0.0.0 GA fires homebrew-bump.yml
  • `curl https://beava.dev/install.sh | sh` — install.sh returns 404
  • `pip install git+...@v0.0.0` — no v0.0.0 tag yet

Replaced with what works today:
```bash
docker run -p 8080:8080 -p 8081:8081 beavadev/beava:edge
cargo install --git https://github.com/beava-dev/beava beava-server
pip install "git+https://github.com/beava-dev/beava.git#subdirectory=python"
```

README "Learn more" + "Community" sprawled across ~13 doc subpage URLs. Trimmed to one beava.dev entry point + in-repo anchors. Less to maintain, less to drift.

11 doc pages referenced `pip install tally` (old codename) plus prose explaining the rename. Replaced the install command with the from-main git+ form; deleted the "PyPI package is currently published as tally" notes (4 docs); fixed the SVG terminal screenshot's success line (`tally-0.0.0` → `beava`). Also stripped 4 leaked `/Users/petrpan26/work/tally/...` Claude memory paths that ended up in arch-doc References sections.

Files

```
README.md | 50 ++++++++--------------
beava-website/project/assets/quickstart-demo.svg | 6 +--
beava-website/project/docs/architecture/... | 3 deletions (leaked paths)
beava-website/project/docs/concepts/... | 14 changes
beava-website/project/docs/get-started/quickstart | 4 +-
beava-website/project/docs/quickstart/ | 11 ++---
beava-website/project/docs/sdk-api/python/ | 5 +--
beava-website/project/guide/chapter-1/ | 2 +-
beava-website/project/guide/recipes/fraud/ | 4 +-
```

12 files changed, +34 / −65. No code changes.

Verification

Followup (when v0.0.0 ships)

Flip the README quickstart to the public install paths once they work:

  • `brew install beava-dev/beava/beava`
  • `pip install beava`
  • `docker run beavadev/beava:latest`

Then this docs cleanup can re-add `brew install` + `install.sh` lines.

Hoang Phan added 5 commits May 7, 2026 15:52
docs: remove stale 'tally' / v0.0.0 / pre-tag references
1781f5f 
Three classes of stale-ref cleanup:

1. README quickstart pointed at install paths that don't work pre-tag:
   - 'brew install beava-dev/beava/beava' — Homebrew tap exists but no
     formula until v0.0.0 GA fires homebrew-bump.yml
   - 'curl https://beava.dev/install.sh | sh' — install.sh returns 404
   - 'pip install git+...@v0.0.0' — no v0.0.0 tag yet
   Replaced with what actually works today: docker run beavadev/beava:edge,
   cargo install --git, pip install git+...#subdirectory=python (no tag).

2. README "Learn more" + "Community" sections sprawled across ~13 doc
   subpage URLs. Trimmed to one beava.dev entry point + the in-repo
   anchors (examples/, beava-bench, contribution docs). Less to maintain,
   less to drift.

3. 11 doc pages in beava-website/project/ referenced 'pip install tally'
   (the old codename) plus paragraphs explaining the rename. Replaced
   the install command with the from-main git+ form; deleted the
   'PyPI package is currently published as tally' notes (4 docs);
   updated the SVG terminal screenshot's success line. Also stripped 4
   leaked '/Users/petrpan26/work/tally/...' Claude memory paths that
   ended up in arch doc References sections.

Files touched: README.md, 11 HTML docs, 1 SVG. No code changes.
docs: second sweep — strip more tally refs, lowercase Beava, drop sta…
f73bc5a 
…le deploy/ artifacts

Follow-up to the first cleanup commit. Wider scope after a fuller grep.

Tally refs removed (user-facing):
  - Cargo.toml repository URL: petrpan26/tally → beava-dev/beava
  - docs/quickstart.md, docs/sdk-api/python.md, docs/concepts/embed-mode.md,
    docs/index.md: 'pip install tally' replaced with the from-main git+
    form; 'Pre-release naming' prose blocks deleted.
  - beava-website/README.md: Cloudflare-Pages onboarding now refers to
    the beava-dev org + beava repo (was 'tally').
  - assets/quickstart-demo.svg: title 'Beava quickstart' → 'beava quickstart'.

Stale artifacts deleted:
  - deploy/README.md (old 'Tally Deploy — Single-VM Launch Demo' guide
    using demo.tally.dev hostnames; replaced months ago by
    beava-website/deploy/).
  - deploy/tally.service, deploy/provision.sh, deploy/smoke.sh,
    deploy/Caddyfile (companions to the deleted README; no other refs
    after deletion).
  - docker-compose.yml at repo root (stale single-service compose using
    TALLY_* env vars + ports 6400/6401 that don't match current beava
    CLI; not referenced anywhere).

Kept: deploy/Dockerfile.beava (referenced by publish-edge-image.yml
+ docs/install.md).

Beava → beava (capitalization rule, per existing memory):
  100+ user-facing markdown + HTML files. JSX identifier names
  (FeedBeaver, useBeavaClient) left intact — those are mascot/component
  names, not the brand wordmark.

Net diff covers ~140 files; all changes are docs/branding/cleanup.
No code or test changes.
docs(website): sharper multi-size favicon + bv.stream → bv.event
0457f98 
Two issues spotted while doing the wider doc cleanup:

1. Browser-tab logo was illegible. The 1280×854 mascot-mark-geometric
   PNG was being downsampled by browsers into noisy mush at 16-32 px.
   Pre-rendered clean variants:

     /assets/favicon-16.png         16×16
     /assets/favicon-32.png         32×32
     /assets/favicon-48.png         48×48
     /assets/apple-touch-icon.png   180×180 (iOS home screen)
     /assets/favicon.ico            16/32/48 multi-image .ico (legacy)

   All composited from the transparent geometric mascot on cream
   (--beava-cream #fdfaf4), with ~10% padding so the figure doesn't
   touch the canvas edge.

   Single-line <link rel="icon"...> across 125 HTML pages updated to
   the multi-link block (32px + 16px + apple-touch + .ico fallback)
   using absolute /assets/ paths so depth-varying pages all resolve.

2. Guide chapter-1, fraud recipe, field-guide chapters, and a couple
   of design-system previews still used the obsolete '@bv.stream'
   decorator name. The current SDK is '@bv.event' (decorator was
   renamed in the events-only pivot, locked Phase 12.7). Replaced
   bv.stream → bv.event across docs/, guide/, design-system/ HTML
   and JSX. 0 hits remaining.
fix(website): update render-docs.mjs favicon block so re-renders don'…
f5d24a4 
…t regress

beava-website/scripts/render-docs.mjs is the source-of-truth template:
docs/*.md → beava-website/project/docs/**/*.html. The previous commit
updated 125 already-rendered HTML files in-place, but a future
`node scripts/render-docs.mjs` would have overwritten them with the
old single <link rel="icon"> pointing at the unscaled mascot PNG.

Sync the template to match — same multi-size block (32 + 16 +
apple-touch + .ico legacy) the rendered pages now carry.
fix(guide): chapter-1 docker tutorial used wrong image, volume, and port
1d4a616 
I tried to follow the chapter-1 'install beava' instructions verbatim
in Docker; every line failed.

Fixes the published commands:

  - 'beava/beava:v0' → 'beavadev/beava:edge' (right namespace; no v0
    tag exists pre-GA, edge is what publish-edge-image.yml ships
    on every push to main).
  - '-v $(pwd)/data:/var/lib/beava' → '-v $(pwd)/data:/data' (the
    container's data dir per docker-compose.prod.yml).
  - 'curl http://localhost:8080/health' → 'curl http://localhost:8090/health'
    (port 8080 is the data plane — push/get only; /health, /ready,
    /metrics, /registry live on the admin port 8090 per the default
    beava.yaml).
  - Docker port mapping gains '-p 8090:8090' so the admin port is
    actually reachable.
  - Replaced the 'brew install beava' line — Homebrew tap exists but
    no formula until v0.0.0 GA fires homebrew-bump.yml. Substituted
    the from-source 'cargo install --git' path that works today.

Same fixes applied to the 4 other places that used the same broken
commands (design-system blog/preview pages, field-guide-ch1 sibling).
petrpan26 pushed a commit that referenced this pull request May 7, 2026
ci(nextest): retry the timing-sensitive drain-cap test up to 3x
b50279f 
test_apply_drains_more_than_1024_items_per_iteration in
phase12_08_drain_until_empty_test.rs is genuinely flaky on CI under
shared runner load — the assertion is 'drained MORE than DRAIN_CAP=1024
items in one event-loop iteration', and runner contention sometimes
keeps that watermark below 1024 even though the test logic is sound.
Hit it twice on PR #6 (a docs-only PR with zero Rust changes), and on
PR #5's CI history. Retry 3x via a per-test nextest override.

Cite the symptom + reason in the config so future maintainers don't
think this is masking a real regression.
@petrpan26 petrpan26 merged commit 7edb158 into main May 7, 2026
13 of 14 checks passed
@petrpan26 petrpan26 deleted the fix/readme-and-doc-stale-refs branch May 7, 2026 21:08
This was referenced May 21, 2026
Open
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@petrpan26