Skip to content

Commit 7a71d37

Browse files
amankoli09amankoli09
authored
feat(docs): Mintlify search tuning for Stellar terminology (#66)
1 parent e1ce0f5 commit 7a71d37

15 files changed

Lines changed: 102 additions & 0 deletions

‎architecture/stellar-cryptography.mdx‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
---
22
title: "Stellar Cryptography"
33
description: "Design rationale, view tag derivation, and RFC-compatible cryptography for Stellar stealth payments."
4+
keywords: "Stellar, soroban, freighter, xlm, lumen, friendbot, stellar.expert, path payment, meta-address"
45
---
56

67
Wraith Protocol implements a non-interactive stealth payment scheme on Stellar. This page documents the cryptography decisions behind the implementation and exactly where each concept is realized in the SDK.

‎contracts/stellar.mdx‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
---
22
title: "Stellar Contracts"
33
description: "Soroban contract specs and deployment"
4+
keywords: "Stellar, soroban, freighter, xlm, lumen, friendbot, stellar.expert, path payment, meta-address"
45
---
56

67
Soroban smart contracts (Rust) for stealth address operations on the Stellar network.

‎docs.json‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,22 @@
1212
"light": "#e6e1e5",
1313
"dark": "#767575"
1414
},
15+
"search": {
16+
"analytics": true,
17+
"synonyms": [
18+
["stealth", "unlinkable"],
19+
["meta-address", "metaaddress", "meta address"],
20+
["Soroban", "Stellar smart contract"],
21+
["friendbot", "testnet faucet"],
22+
["XLM", "lumen"],
23+
["Freighter", "Stellar wallet"]
24+
],
25+
"boosts": [
26+
{ "page": "getting-started", "weight": 3 },
27+
{ "group": "Guides", "weight": 2 },
28+
{ "group": "API Reference", "weight": 1 }
29+
]
30+
},
1531
"font": {
1632
"headings": {
1733
"family": "Space Grotesk",

‎docs/SEARCH_TESTS.md‎

Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
# Mintlify Search Tests
2+
3+
These tests verify that our Mintlify search configuration (synonyms, boosts, and keywords) yields the most relevant pages for common Stellar developer queries.
4+
5+
## Test Queries and Expected Results
6+
7+
1. **`stealth`**
8+
- **Expected Result:** `How Stealth Payments Work` (or related stealth guides)
9+
- **Reasoning:** Tests the core concept.
10+
11+
2. **`unlinkable`**
12+
- **Expected Result:** `How Stealth Payments Work`
13+
- **Reasoning:** Tests synonym mapping `stealth ↔ unlinkable`.
14+
15+
3. **`meta-address`**
16+
- **Expected Result:** Stealth payments / Architecture overview
17+
- **Reasoning:** Tests core terminology.
18+
19+
4. **`metaaddress`**
20+
- **Expected Result:** Stealth payments / Architecture overview
21+
- **Reasoning:** Tests synonym mapping `meta-address ↔ metaaddress ↔ meta address`.
22+
23+
5. **`Soroban`**
24+
- **Expected Result:** `Stellar Contracts`
25+
- **Reasoning:** Tests synonym mapping `Soroban ↔ Stellar smart contract`.
26+
27+
6. **`Stellar smart contract`**
28+
- **Expected Result:** `Stellar Contracts`
29+
- **Reasoning:** Ensures explicit terminology maps correctly.
30+
31+
7. **`friendbot`**
32+
- **Expected Result:** Stellar testing/troubleshooting guides
33+
- **Reasoning:** Tests synonym mapping `friendbot ↔ testnet faucet`.
34+
35+
8. **`testnet faucet`**
36+
- **Expected Result:** Stellar testing/troubleshooting guides
37+
- **Reasoning:** Tests synonym mapping for friendbot.
38+
39+
9. **`XLM`**
40+
- **Expected Result:** Stellar core pages (Getting Started / Primitives)
41+
- **Reasoning:** Tests synonym mapping `XLM ↔ lumen`.
42+
43+
10. **`lumen`**
44+
- **Expected Result:** Stellar core pages
45+
- **Reasoning:** Tests synonym mapping for XLM.
46+
47+
11. **`Freighter`**
48+
- **Expected Result:** `Stellar Transaction Simulation` / Wallet guides
49+
- **Reasoning:** Tests synonym mapping `Freighter ↔ Stellar wallet`.
50+
51+
12. **`Stellar wallet`**
52+
- **Expected Result:** `Stellar Transaction Simulation` / Wallet guides
53+
- **Reasoning:** Tests synonym mapping for Freighter.
54+
55+
13. **`stellar.expert`**
56+
- **Expected Result:** `Stellar Troubleshooting Guide` or `Stellar Mainnet Deployment`
57+
- **Reasoning:** Tests frontmatter keyword injection for Stellar pages.
58+
59+
14. **`path payment`**
60+
- **Expected Result:** `Stellar Custom Assets` or core Stellar guides
61+
- **Reasoning:** Tests frontmatter keyword injection for Stellar pages.
62+
63+
15. **`getting started stellar`**
64+
- **Expected Result:** `Getting Started`
65+
- **Reasoning:** Tests page weighting (getting-started > guides > reference). The Overview section's `getting-started` page should appear first due to the boost weight `3`.
66+
67+
## Acceptance Criteria Checklist
68+
69+
- [x] Search analytics enabled in `docs.json`
70+
- [x] Synonyms configured for key Stellar terms
71+
- [x] Page weighting implemented to prioritize Getting Started and Guides
72+
- [x] Stellar keywords injected into `.mdx` frontmatter
73+
- [ ] Manual verification completed for each query above

‎guides/spectre-stellar-cookbook.mdx‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
---
22
title: "Spectre + Stellar Cookbook"
33
description: "Three production-ready recipes for building Stellar agents with Wraith"
4+
keywords: "Stellar, soroban, freighter, xlm, lumen, friendbot, stellar.expert, path payment, meta-address"
45
---
56

67
Three complete recipes for building Stellar agents in production. Each is copy-pasteable and covers the full lifecycle: agent creation, funding, payments, webhooks, and privacy automation.

‎guides/stellar-custom-assets.mdx‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
---
22
title: "Stellar Custom Assets (USDC)"
33
description: "Send and receive stealth USDC payments on Stellar — trustlines, SAC mechanics, and path payments"
4+
keywords: "Stellar, soroban, freighter, xlm, lumen, friendbot, stellar.expert, path payment, meta-address"
45
---
56

67
Most real-world Stellar integrations use USDC, not XLM. This guide covers everything you need to send and receive stealth USDC (and other Stellar assets) without running into trustline errors, clawback surprises, or SAC authorization blocks.

‎guides/stellar-federation.mdx‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
---
22
title: "Stellar Federation Addresses"
33
description: "Resolve alice*example.com to a Stellar address using SEP-0002 and the Wraith SDK"
4+
keywords: "Stellar, soroban, freighter, xlm, lumen, friendbot, stellar.expert, path payment, meta-address"
45
---
56

67
Stellar federation addresses look like `alice*example.com` — a human-readable alias that resolves to a `G...` public key through a lightweight HTTP lookup. This guide covers what federation is, how to set it up for your own domain, how to use the SDK's `resolveStellarFederation()` helper, and the UX and failure-mode considerations for production payment flows.

‎guides/stellar-mainnet-deployment.mdx‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
---
22
title: "Stellar Mainnet Deployment"
33
description: "Operator guide for running Wraith Stellar contracts on mainnet — hosting, funding, contract addresses, RPC, monitoring, and incident response"
4+
keywords: "Stellar, soroban, freighter, xlm, lumen, friendbot, stellar.expert, path payment, meta-address"
45
---
56

67
This guide is for **operators** deploying and running Wraith Stellar contracts on mainnet: validators, custody providers, and Spectre instance hosts. It covers everything from hardware requirements to upgrade governance.

‎guides/stellar-multisig-withdrawal.mdx‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
---
22
title: "Stellar Multisig Stealth Withdrawals"
33
description: "Coordinate multiple signers to authorize stealth withdrawals from a multisig Stellar account"
4+
keywords: "Stellar, soroban, freighter, xlm, lumen, friendbot, stellar.expert, path payment, meta-address"
45
---
56

67
Stealth withdrawals from a multisig source account require every participating signer to contribute a valid signature before the transaction can be submitted. This guide walks through Stellar's native multisig model, how it interacts with stealth address mechanics, and how to coordinate N-of-M signing using the Wraith SDK.

‎guides/stellar-offline-signing.mdx‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
---
22
title: "Stellar Offline Transaction Signing"
33
description: "Build transactions online, sign them on an air-gapped machine, and submit them without the private key ever touching an internet-connected device"
4+
keywords: "Stellar, soroban, freighter, xlm, lumen, friendbot, stellar.expert, path payment, meta-address"
45
---
56

67
Cold storage and air-gapped wallets keep private keys on a machine that never connects to the internet. Signing a Stellar transaction with such a setup requires moving data — not keys — between the online and offline environments. This guide walks through the full workflow, QR code transfer patterns, hardware wallet integration, and stealth-specific guidance.

0 commit comments

Comments
 (0)