babylonlabs-io / babylonlabs-io/babylonlabs.github.io

docs(tbv): correct terminology in the protocol architecture diagram (10.png)

Open
#455 1 comment 0 reactions 0 assignees View on GitHub
Dominant language
TypeScript
Stars
5
Forks
10
Avg merge
3d 1h
Merged PRs (30d)
1

Description

Follow-up to #453. The text-side terminology is now aligned, but `10.png` is a raster export with no source file in the repo, so these corrections need a new export from the design source.

**File:** `static/img/trustless-bitcoin-vault/confluence/technical-details/protocol-architecture/10.png`

> [!IMPORTANT]
> **Updated after Sarah's canonical TBV language document.** Two labels below changed after this issue was first written. If you already sent the earlier list to the designer, send this one instead.
>
> - Item 1 is now **`APP KEEPER`**, not `APPLICATION VAULT KEEPER`. That role has been renamed.
> - Item 2 is new: the spoke is now **`BTCVault Swap Spoke`**, not `BTC Vault Swap Spoke`.

### Blocking — contradicts the docs

1. **`VAULT KEEPER — CLAIMER / CHALLENGER` → `APP KEEPER — CLAIMER / CHALLENGER`**

The box sits as a peer of `VAULT PROVIDER`, but "Vault Keeper" is the *set* that covers all three operator roles — Vault Provider, Universal Challenger, and App Keeper. The box means the application's own keeper, which is now called the **App Keeper**. Originally flagged by @kkkk666; the label has since changed again under Sarah's terminology document.

2. **`BTC Vault Swap Spoke` → `BTCVault Swap Spoke`**

The spoke takes the `BTCVault` spelling: one word, capital B, T, C, V. This label was correct when the issue was filed and is not any more.

### Casing — diverges from house style

The docs use `WBTC` and `Aave v4` everywhere (zero occurrences of `wBTC` or `Aave V4`):

3. `swap collateral to wBTC for permissionless liquidation` → **`WBTC`**
4. `Aave V4` → **`Aave v4`** (twice, in the `#1` and `#2` collateral-record cards)
5. `Off-chain ceremony — encapsulated by sdk` → **`SDK`**

### Also spotted while verifying the image

6. `AAVE Hub` → **`Aave v4 Hub`** — the docs never use all-caps `AAVE`.
7. `BTC Vault Registry` → **`Vault registry`** — the name used in `protocol-architecture.mdx`.
8. `TxGraph presigning (N-of-N)` → **`Transaction graph pre-signing (N-of-N)`**, matching the prose. The docs hyphenate: `pre-signed` appears 33 times, `presigning` zero.
9. Optional, if the chip has room: `Protocol Params` → **`Protocol parameters`**.

Items 6–9 are lower priority than 1–5.

### Note

The alt text on this image was written to describe the actors generically, so it stays accurate both before and after this re-export. If the labels change substantially, re-check it.

Contributor guide

No contributing guide indexed for this repository

Research direction

Read protocol-architecture.mdx and inspect static/img/trustless-bitcoin-vault/confluence/technical-details/protocol-architecture/10.png against the listed terminology. The design source is not in the repository, so coordinate a new export using the updated items 1–5 and lower-priority items 6–9. Done means the replacement image uses the approved labels and its alt text has been re-checked.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.