Skip to content

Commit bafd573

Browse files
committed
docs: fix USDT0 naming and FAQ formatting
1 parent fd32860 commit bafd573

19 files changed

Lines changed: 55 additions & 42 deletions

‎STYLEGUIDE.md‎

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,9 +48,11 @@ Before returning any page, read it back and answer these four questions. Fix any
4848
| STABLE | Referring to the token (all caps) | Stable (when meaning the token), stable |
4949
| StableChain | Referring to the underlying settlement layer / protocol (capital S and C) | Stablechain, Stable chain, stablechain |
5050
| Stablechain | Only in the introductory definition ("Stable is the first Stablechain") | |
51-
| USDT | Referring to the asset | Tether (unless referring to the company) |
51+
| USDT | Referring to native USDT on a source chain, or to the broader asset where the distinction from USDT0 does not matter | Usdt, Tether (unless referring to the company) |
52+
| USDT0 | Referring to the omnichain asset, including Stable's native gas and settlement asset | Usdt0, USDT when referring specifically to the asset on Stable |
5253

5354
- Use the product or protocol name exactly as branded (e.g., "LayerZero", "RedStone", "USDT0").
55+
- Never title-case an acronym or branded identifier. Write `USDT0`, `FAQ`, and `API`, not `Usdt0`, `Faq`, or `Api`.
5456

5557
### UI and keyboard actions
5658

@@ -65,6 +67,11 @@ Before returning any page, read it back and answer these four questions. Fix any
6567
- Do not use title case (e.g., ~~"Gas Pricing And Fees"~~).
6668
- Vocs builds the right-side outline from your headings, so keep them short and scannable.
6769

70+
### FAQ sections
71+
72+
- In an FAQ section within a larger page, write each question as a `###` heading. This gives every question a visible hierarchy and a stable anchor.
73+
- On the dedicated `reference/faq.mdx` page, write each question as a bold paragraph ending in `?`. The structured-data parser uses that format to generate `FAQPage` question-and-answer entries.
74+
6875
## Frontmatter
6976

7077
Every page must include these three fields, in this order:
@@ -120,6 +127,12 @@ Every page has exactly one home in the sidebar. Edit only the `/en` section of `
120127

121128
When a concept is relevant to multiple sections (e.g., a Learn concept that readers also need mid-task in Build), keep it in its canonical section and surface it from the others through **content**, not navigation. Link to it from the relevant overview page inline. Concepts live in one place; task-oriented sections point at them.
122129

130+
### Sidebar labels
131+
132+
- Use sentence case for English sidebar labels.
133+
- Preserve the exact capitalization of acronyms, standards, and branded identifiers such as `USDT0`, `FAQ`, `API`, `JSON-RPC`, and `EIP-7702`.
134+
- Match the destination page's title unless the surrounding navigation provides context that allows a shorter label.
135+
123136
## Page structure
124137

125138
Follow this general pattern:

‎docs/pages/en/explanation/bank-module.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,4 +39,4 @@ The full method signatures, event payloads, and authorization flow are in the [B
3939

4040
- [**Bank precompile reference**](/en/reference/bank-module-api): Call `transfer`, `approve`, `mint`, `burn`, and read events.
4141
- [**System modules overview**](/en/explanation/system-modules-overview): Return to the full list of precompile-exposed modules.
42-
- [**USDT as gas**](/en/explanation/usdt-as-gas-token): Understand the dual-role asset model the bank module manages.
42+
- [**USDT0 as gas**](/en/explanation/usdt-as-gas-token): Understand the dual-role asset model the bank module manages.

‎docs/pages/en/explanation/confidential-transfer.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,6 @@ Confidential Transfer is in development. See [Roadmap](/en/explanation/technical
5353

5454
## Next recommended
5555

56-
- [**USDT as gas**](/en/explanation/usdt-as-gas-token): Understand the asset model confidential transfers shield.
56+
- [**USDT0 as gas**](/en/explanation/usdt-as-gas-token): Understand the asset model confidential transfers shield.
5757
- [**Flow of funds**](/en/explanation/flow-of-funds): See where confidentiality fits in the end-to-end payment lifecycle.
5858
- [**Roadmap**](/en/explanation/technical-roadmap): Track when confidential transfer ships.

‎docs/pages/en/explanation/eip-7702.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,5 +47,5 @@ After submission, the EOA's account code is set to the delegate. Subsequent tran
4747
## Next recommended
4848

4949
- [**Account Abstraction (EIP-7702)**](/en/reference/eip-7702-api): Implement batch payments, spending limits, and session keys against a delegate contract.
50-
- [**USDT as gas**](/en/explanation/usdt-as-gas-token): Understand the gas model that EIP-7702 transactions run on.
50+
- [**USDT0 as gas**](/en/explanation/usdt-as-gas-token): Understand the gas model that EIP-7702 transactions run on.
5151
- [**Gas waiver**](/en/explanation/gas-waiver): Compare delegation to gas-waived flows where an application pays the user's gas instead.

‎docs/pages/en/explanation/erc-3009.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -91,6 +91,6 @@ This property is what makes ERC-3009 on Stable a strong foundation for higher-le
9191

9292
**See also:**
9393

94-
- [USDT as Gas](/en/explanation/usdt-as-gas-token)
94+
- [USDT0 as gas](/en/explanation/usdt-as-gas-token)
9595
- [USDT0 Behavior on Stable](/en/explanation/usdt0-behavior)
9696
- [x402 (HTTP-Native Payments)](/en/explanation/x402)

‎docs/pages/en/explanation/ethereum-comparison.mdx‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ On Stable, transaction fees are paid in USDT0, not a volatile native token. This
4646

4747
- Users need USDT0 in their wallet to submit transactions.
4848
- The `value` field in transactions still works for sending USDT0, similar to how ETH is sent on Ethereum.
49-
- See [USDT as gas](/en/explanation/usdt-as-gas-token) for details.
49+
- See [USDT0 as gas](/en/explanation/usdt-as-gas-token) for details.
5050

5151
### 3. No priority tips
5252

@@ -74,6 +74,6 @@ USDT0 functions as both the native gas token and an ERC-20 token. This introduce
7474

7575
## Next recommended
7676

77-
- [**USDT as gas**](/en/explanation/usdt-as-gas-token): Understand the asset model that replaces ETH for gas.
77+
- [**USDT0 as gas**](/en/explanation/usdt-as-gas-token): Understand the asset model that replaces ETH for gas.
7878
- [**Gas pricing**](/en/explanation/gas-pricing): Review the single-component fee model in detail.
7979
- [**USDT0 behavior on Stable**](/en/explanation/usdt0-behavior): Audit contracts for dual-role asset semantics, allowance safety, and `EXTCODEHASH` behavior.

‎docs/pages/en/explanation/flow-of-funds.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,6 @@ The conversion logic (e.g., BTC → USDT) may be handled by an exchange partner,
6060

6161
## Next recommended
6262

63-
- [**USDT as gas**](/en/explanation/usdt-as-gas-token): Understand how USDT0 serves as both native gas and ERC-20 balance on Stable.
63+
- [**USDT0 as gas**](/en/explanation/usdt-as-gas-token): Understand how USDT0 serves as both native gas and ERC-20 balance on Stable.
6464
- [**Bridging USDT0 to Stable**](/en/explanation/usdt0-bridging): See how USDT0 moves onto Stable from other chains via OFT Mesh or Legacy Mesh.
6565
- [**Send your first USDT0**](/en/tutorial/send-usdt0): Submit a USDT0 transfer on testnet using standard EVM tooling.

‎docs/pages/en/explanation/gas-pricing.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,5 +36,5 @@ Stable accepts EIP-1559 (Type 2) transactions, but `maxPriorityFeePerGas` is alw
3636
## Next recommended
3737

3838
- [**Gas pricing reference**](/en/reference/gas-pricing-api): Construct transactions, estimate gas, and configure tooling against Stable's fee model.
39-
- [**USDT as gas**](/en/explanation/usdt-as-gas-token): See how USDT0 serves as both native gas and ERC-20 balance.
39+
- [**USDT0 as gas**](/en/explanation/usdt-as-gas-token): See how USDT0 serves as both native gas and ERC-20 balance.
4040
- [**Ethereum comparison**](/en/explanation/ethereum-comparison): Review every behavior difference you'll encounter porting from Ethereum.

‎docs/pages/en/explanation/gas-waiver.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,4 +56,4 @@ For flows where the user does hold USDT0 but wants to bundle multiple calls into
5656

5757
- [**Enable gas-free transactions**](/en/how-to/integrate-gas-waiver): Integrate the hosted Waiver Server API with API-key submission and NDJSON responses.
5858
- [**Gas waiver protocol**](/en/reference/gas-waiver-api): Read the full protocol spec: marker routing, wrapper format, governance controls.
59-
- [**USDT as gas**](/en/explanation/usdt-as-gas-token): Understand the gas token that the waiver covers.
59+
- [**USDT0 as gas**](/en/explanation/usdt-as-gas-token): Understand the gas token that the waiver covers.

‎docs/pages/en/explanation/key-features.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Stable is a delegated Proof-of-Stake Layer 1 with single-slot finality, full EVM
1919

2020
## USDT-specific features
2121

22-
- [**USDT as gas**](/en/explanation/usdt-as-gas-token): USDT0 serves as both the native gas token and an ERC-20 token on the same balance.
22+
- [**USDT0 as gas**](/en/explanation/usdt-as-gas-token): USDT0 serves as both the native gas token and an ERC-20 token on the same balance.
2323
- [**Gas waiver**](/en/explanation/gas-waiver): Governance-authorized waivers submit wrapper transactions that execute at zero gas price on the user's behalf.
2424
- [**Guaranteed blockspace**](/en/explanation/guaranteed-blockspace): Enterprise partners secure reserved capacity in every block for payment flows.
2525
- [**USDT transfer aggregator**](/en/explanation/usdt-transfer-aggregator): High-volume USDT0 transfers batch into parallelized, fault-tolerant settlement bundles.

0 commit comments

Comments
 (0)