Skip to content

docs: rephrase BYOK on user-facing surfaces + fix M65 changelog typo#47

Merged
indykish merged 11 commits into
mainfrom
chore/m65-byok-marketing-rephrase
May 10, 2026
Merged

docs: rephrase BYOK on user-facing surfaces + fix M65 changelog typo#47
indykish merged 11 commits into
mainfrom
chore/m65-byok-marketing-rephrase

Conversation

@indykish
Copy link
Copy Markdown
Contributor

@indykish indykish commented May 10, 2026

Summary

Companion docs PR for the M65 marketing rephrase shipped in usezombie/usezombie#310. Drops the cryptic `BYOK` acronym from user-facing docs copy and replaces it with plain English ("bring your own model" / "you pick the model and pay your provider directly", Kilo Code style).

The historical M48 changelog entry is left as-is — it's archive content describing what shipped, including the canonical API value `"mode": "byok"`. Renaming the persisted posture identifier is out of scope.

While here, also fixes the `$0.001` typo in the M65 changelog entry (event rate is $0.01) and recomputes the worked example math ($31.00, not $30.10).

Files

  • index.mdx — description, Early Access warning, three-pillars card, architecture link
  • concepts.mdx — tenant tree example, "Credits" section heading, two inference bullets
  • changelog.mdx — M65 entry only ($0.001 → $0.01, $30.10 → $31.00, BYOK → model-provider)
  • .gitignore — add `.gstack/` (carried in from main, unrelated)

Test plan

  • Mintlify preview renders without broken links
  • No remaining BYOK in non-historical copy: `grep -n BYOK *.mdx` shows only changelog M48-era entries
  • M65 changelog math reads correctly: `100 events × 3 stages each = $31.00`

🤖 Generated with Claude Code

Greptile Summary

This PR replaces the acronym BYOK with plain-English phrasing ("you bring your provider and model, pay them directly") across index.mdx, concepts.mdx, quickstart.mdx, and changelog.mdx, and introduces snippets/rates.mdx as a single source of truth for pricing constants that fixes the $0.001 typo (→ $0.01 per event).

  • snippets/rates.mdx introduced — exports EVENT_RATE, STAGE_RATE, and STARTER_CREDIT; imported by all four MDX pages, replacing scattered hardcoded strings.
  • M65 changelog entry revised — heading shortened, upgrading/API bullets condensed, BYOK removed; rate values now rendered via variables throughout the entry.
  • quickstart.mdx sign-in step corrected — starter credit now explicitly described as covering hosted execution only, with a separate sentence for provider-direct inference billing; resolves the previously flagged inference-coverage contradiction.

Confidence Score: 4/5

Safe to merge for BYOK copy and quickstart fixes; the M65 changelog entry now uses dynamic rate variables where hardcoded historical values would be safer.

The rate variable approach in the M65 historical changelog entry means any future rate change will retroactively alter what M65 is documented to have shipped. The M48 entry uses hardcoded values and stays fixed. The rest of the doc copy changes are clean.

changelog.mdx — M65 rate variable references; if the event or stage rate changes, those lines will silently show the new rate while still describing the M65 launch.

Important Files Changed

Filename Overview
changelog.mdx M65 entry updated with variable rate references and BYOK copy removed; dynamic rate variables in a historical changelog entry risk retroactive price misrepresentation if rates change in a future milestone
snippets/rates.mdx New single-source-of-truth snippet exporting EVENT_RATE ($0.01), STAGE_RATE ($0.10), and STARTER_CREDIT ($5); corrects the $0.001 typo that was previously hardcoded in changelog
concepts.mdx BYOK replaced with plain-English provider/model phrasing; tree diagram fixed to provider: anthropic; credits section cleanly explains the zero-markup model
index.mdx BYOK pillar card replaced with plain-English copy; stealth-mode warning updated; imports STARTER_CREDIT variable
quickstart.mdx Sign-in step now correctly describes starter credit as covering hosted execution only; previous inference-coverage issue resolved
.gitignore Adds .gstack/ entry; unrelated housekeeping carried in from main

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    R[snippets/rates.mdx\nEVENT_RATE · STAGE_RATE · STARTER_CREDIT]
    R --> I[index.mdx\nSTARTER_CREDIT]
    R --> C[concepts.mdx\nSTARTER_CREDIT]
    R --> Q[quickstart.mdx\nSTARTER_CREDIT]
    R --> CL[changelog.mdx\nEVENT_RATE · STAGE_RATE · STARTER_CREDIT]
    CL --> M65[M65 entry\nvariable = dynamic ⚠️]
    CL --> M48[M48 entry\nhistorical · untouched]
Loading

Comments Outside Diff (1)

  1. changelog.mdx, line 51-68 (link)

    P1 Rate variables in historical changelog make pricing retroactively mutable

    The M65 entry now renders its prices via {EVENT_RATE} and {STAGE_RATE}. If either rate is bumped in a future milestone, those same lines will silently show the new rate while still narrating the M65 launch — making the historical record factually wrong. A reader comparing what M65 shipped against a future rate change has no way to tell the entries apart. The M48 entry uses hardcoded strings for this reason. Historical changelog entries should anchor their rate figures at the values that were true when the milestone shipped.

    Prompt To Fix With AI
    This is a comment left during a code review.
    Path: changelog.mdx
    Line: 51-68
    
    Comment:
    **Rate variables in historical changelog make pricing retroactively mutable**
    
    The M65 entry now renders its prices via `{EVENT_RATE}` and `{STAGE_RATE}`. If either rate is bumped in a future milestone, those same lines will silently show the new rate while still narrating the M65 launch — making the historical record factually wrong. A reader comparing what M65 shipped against a future rate change has no way to tell the entries apart. The M48 entry uses hardcoded strings for this reason. Historical changelog entries should anchor their rate figures at the values that were true when the milestone shipped.
    
    How can I resolve this? If you propose a fix, please make it concise.
Prompt To Fix All With AI
Fix the following 2 code review issues. Work through them one at a time, proposing concise fixes.

---

### Issue 1 of 2
changelog.mdx:51-68
**Rate variables in historical changelog make pricing retroactively mutable**

The M65 entry now renders its prices via `{EVENT_RATE}` and `{STAGE_RATE}`. If either rate is bumped in a future milestone, those same lines will silently show the new rate while still narrating the M65 launch — making the historical record factually wrong. A reader comparing what M65 shipped against a future rate change has no way to tell the entries apart. The M48 entry uses hardcoded strings for this reason. Historical changelog entries should anchor their rate figures at the values that were true when the milestone shipped.

### Issue 2 of 2
changelog.mdx:51-54
**Worked example math was dropped rather than corrected**

The PR description states it "recomputes the worked example math ($31.00, not $30.10)" and the test plan checks `100 events × 3 stages each = $31.00`. However, the old inline calculation was removed entirely rather than corrected. The new "What's new" bullet only points readers to `usezombie.com/#pricing` for the diagram. If the marketing site is now the canonical home for the calculation that is intentional, but the PR description's own test plan item 3 will not pass against this file.

Reviews (9): Last reviewed commit: "docs: stealth-mode banner + sunset BYOK ..." | Re-trigger Greptile

…banner

Companion to usezombie/usezombie#310 (M65 marketing rephrase). On the docs
site, replace BYOK on user-facing surfaces with plain English ("bring your
own model" / "you pick the model and pay your provider directly"). Keep
BYOK in the historical M48 changelog entry — that's archive content
describing what shipped, including the canonical API value `"mode": "byok"`.

- index.mdx
  - description: lifted to README's "always-on agent runtime" framing,
    dropped the comma-stuffed BYOK adjective
  - Early Access warning: shortened to one sentence (matches README §16)
  - "Three pillars" Card title: BYOK (Bring Your Own Key) → Bring your
    own model
  - Architecture link: "billing + BYOK" → "billing + model providers"

- concepts.mdx
  - Tenant tree example: `BYOK: anthropic` → `model: anthropic`
  - Section heading: "Credits and BYOK" → "Credits and your model provider"
  - Bullets: "Inference is BYOK." / "Inference cost is BYOK" rephrased

- changelog.mdx (M65 entry)
  - Fix the $0.001 typo from the original ship: $0.001 → $0.01
  - Recompute the worked example: $30.10 → $31.00 (the wrong number
    cascaded from the typo)
  - "BYOK inference" → "your model-provider inference"

- .gitignore: add `.gstack/` (carried in from main, unrelated to BYOK)

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Comment thread index.mdx
Comment thread concepts.mdx Outdated
indykish and others added 5 commits May 10, 2026 08:36
- snippets/rates.mdx: single source of truth for STARTER_CREDIT, EVENT_RATE,
  STAGE_RATE on the docs site. Mirrors src/state/tenant_billing.zig and
  ui/packages/website/src/lib/rates.ts. Bumping a rate in the usezombie
  repo now requires a paired one-line update in this snippet (not the
  three .mdx files that used to hand-type "$5").

- index.mdx, concepts.mdx, quickstart.mdx: import STARTER_CREDIT from the
  snippet; render {STARTER_CREDIT} in place of the literal "$5". Four
  hand-typed strings collapsed to one source.

- index.mdx Warning: rewritten to terse Early Access copy with the design-
  partner contact channels (nkishore@megam.io / usezombie@agentmail.to /
  https://x.com/indykish) and the pre-2.0 timing.

EVENT_RATE / STAGE_RATE are exported alongside but not yet referenced —
they're available for any future user-facing copy that quotes per-event
or per-stage pricing.

The historical changelog $5/$10 mentions are unchanged — those are
archive content describing what shipped at each milestone.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
…h $0.001 fix

Tightens the May 9 + May 8 entries Captain reads first on every visit.
Same load-bearing facts (error codes, env vars, breaking changes) — fewer
words, no marketing fluff, no repetition between heading and lead.

While here, fixed the two remaining $0.001 typos in the M65 entry that
the previous commit missed (heading line + the /v1/billing/charges
description). Site-wide rate is now consistent at $0.01.

Older entries (May 7 and earlier — 44 entries) untouched in this commit.
Comment thread quickstart.mdx Outdated
…ling

- quickstart.mdx: starter credit no longer claims to cover inference
  against a platform-managed default model. Under the new framing the
  credit pool covers hosted execution only (event receipts + stages);
  inference is BYOK and billed by the user's provider.
- snippets/rates.mdx: inline comments on EVENT_RATE / STAGE_RATE flag
  the hardcoded copies in changelog.mdx historical entries so a future
  rate change updates both surfaces.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@indykish
Copy link
Copy Markdown
Contributor Author

Both addressed in 8224813.

Issue 1 — quickstart.mdx:42: dropped the "and inference against the platform-managed default model" tail. New copy: "never expires, covers hosted execution (event receipts + stages). You bring your own model and pay your provider directly; usezombie marks up zero on inference." — matches concepts.mdx framing.

Issue 2 — snippets/rates.mdx:13-14: added the suggested trailing comments on EVENT_RATE and STAGE_RATE flagging that changelog.mdx historical entries hardcode these values. Didn't pursue MDX import into changelog.mdx because those are historical archives — by design they record what shipped at the time, including obsolete values. The comment makes the coupling explicit for any future rate change.

indykish and others added 3 commits May 10, 2026 09:27
Per follow-up review feedback: rewrite historical entries too so every
mention of the current $0.01 / $0.10 / $5 values flows through the
snippet imports. A future rate change updates one file and propagates.

- Imports STARTER_CREDIT, EVENT_RATE, STAGE_RATE at the top of
  changelog.mdx.
- Substitutes 8 inline literals across the M65, M52 and M51 entries.
- Two heading literals rephrased ("Single-rate pricing — tier ladder
  retired", "M51 follow-up — route teardown, starter-credit cut, ...")
  to keep MDX expression syntax out of Markdown ATX headings.
- Historical "(was $10)" left literal — that's an obsolete value, not
  the current STARTER_CREDIT, so it correctly stays a frozen archive.
- Drops the "also hardcoded in changelog.mdx" caveat from rates.mdx
  comments — no longer true.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Surrounding prose calls this the provider; the diagram label was the
only outlier. Aligns the field name with the rest of the doc.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Greptile flagged the inconsistency: per-unit rates flow through
{EVENT_RATE}/{STAGE_RATE} but the "= \$31.00" total was hardcoded, so
a future rate change would render the math visibly wrong. Dropping the
worked example keeps the bullet rate-agnostic; the diagram still
communicates the structure.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@indykish
Copy link
Copy Markdown
Contributor Author

Greptile flag on changelog.mdx:26 (hardcoded $31.00 worked example): fixed in d607b0f by dropping the worked example. The bullet now reads rate-agnostic — event cell ({EVENT_RATE}) → N stage cells ({STAGE_RATE}) → separate LLM stratum — so a future rate change can't render the math visibly wrong.

- index.mdx, changelog.mdx: "Early Access Preview" callout reframed
  as "stealth-mode testing" with a single contact email
  (usezombie@agentmail.to). Drops the personal nkishore@megam.io
  in line with one-canonical-support-email direction.
- concepts.mdx, quickstart.mdx, index.mdx three-pillars card:
  "Bring your own model" -> "You bring your provider and model"
  per the KiloCode framing. The term BYOK is now retired from every
  user-facing prose surface in this docs repo (historical changelog
  entries stay as archives).

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@indykish indykish merged commit 216f991 into main May 10, 2026
4 checks passed
@indykish indykish deleted the chore/m65-byok-marketing-rephrase branch May 11, 2026 05:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant