Skip to main content

User Guides

End-user documentation for Peer buyers and sellers.

Audience​

Non-technical users who need help using the Peer platform for fiat-to-crypto and crypto-to-fiat exchanges.

Directory Structure​

guides/
├── introduction/
│   └── zkp2p.md                # Platform overview
├── for-buyers/
│   ├── index.md
│   ├── complete-guide-to-onboarding.md
│   ├── guide-to-partial-release.md
│   ├── handling-verification-issues.md
│   └── tiers.md                # Tier limits/fees (source of truth: curator tierConstants.ts)
├── for-sellers/
│   ├── index.md
│   ├── provide-liquidity-sell-usdc.md
│   ├── provide-liquidity-diff-chain.md
│   ├── automated-rate-management.md
│   ├── arm-*.md                # ARM: spread (express/advanced), floor rates, monitoring
│   ├── manual-releases.md
│   ├── monitor-your-deposit.md
│   ├── choose-an-earning-strategy.md
│   ├── private-orders.md
│   ├── notifications.md
│   ├── referrals.md
│   └── calculating-apr.md
├── for-vault-managers/
│   ├── index.md
│   └── run-a-vault.md
└── privacy-safety/
    ├── index.md
    ├── privacy.md
    └── risks.md

Writing Guidelines​

Tone​

  • Clear, approachable language
  • Avoid technical jargon (or explain it)
  • Step-by-step instructions
  • Assume no blockchain experience

Content Patterns​

  1. Numbered steps for procedures — each step is "action → what you should see", written in text
  2. No app-UI screenshots. They rot with every redesign. Describe the surface by its current nav names (Trade, Earn, Activity) and verified button labels instead
  3. Tables for role comparisons, platform lists, and fee breakdowns
  4. Admonitions only for genuine forks in the road (irreversible actions, verification pitfalls) — never for emphasis
  5. Links to related guides instead of repeating their content

Admonition Usage​

:::info
Helpful context or tips.
:::

:::warning
Important caveats or things to watch out for.
:::

:::danger
Critical security warnings.
:::

Common Updates​

  1. UI changes: Update nav names and button labels in prose; verify against clients/web/src
  2. New feature: Add guide following existing patterns
  3. Process changes: Update step-by-step instructions