This directory is the single source of truth for all SwiftRemit documentation beyond the top-level README. Every document listed here is current; anything that used to live at the repository root has been moved or deleted (SR-115).
| Document | Description |
|---|---|
| QUICK_START.md | Get running locally with Docker Compose |
| GETTING_STARTED.md | Manual setup and first deployment |
| DEPLOYMENT.md | Full deployment guide (testnet → mainnet) |
| TESTNET_SETUP_GUIDE.md | Automated testnet setup script walkthrough |
| CONFIGURATION.md | All environment variables and config options |
| MIGRATION.md | Contract migration guide |
| RUNBOOK.md | Operational runbook — pause/unpause, key rotation, etc. |
| Document | Description |
|---|---|
| api/API.md | REST API reference |
| api/OPENAPI.md | OpenAPI spec, implementation notes, and test results |
| EVENTS.md | Contract event catalogue (topics, payload shapes) |
| WEBHOOKS.md | Webhook integration guide (SR-026) |
| TRACING.md | Distributed tracing setup |
| Document | Description |
|---|---|
| TRANSACTION_CONTROLLER.md | Transaction controller design |
| TRANSACTION_STATE_MACHINE.md | Remittance lifecycle state machine |
| FEE_SERVICE.md | Fee calculation service — architecture, API, and refactor history |
| ASSET_VERIFICATION.md | Asset verification system |
| Document | Description |
|---|---|
| testing/PROPERTY_TESTING.md | Property-based test suite — guide, examples, index, and checklist |
| testing/STATE_MACHINE_TESTING.md | State machine test guide |
| testing/TESTING_COMPLETE.md | Test completion report |
| testing/TESTING_FEE_BREAKDOWN.md | Fee breakdown test results |
| Document | Description |
|---|---|
| THREAT_MODEL.md | Threat model and attack surface analysis |
| COMPLIANCE_CONTROLS.md | AML/KYC compliance controls |
| VULNERABILITY_EXCEPTIONS.md | Known vulnerability exceptions |
| VULNERABILITY_RESPONSE_SLA.md | Vulnerability response SLAs |
| KEY_MANAGEMENT_POLICY.md | Key management policy |
| REPRODUCIBLE_BUILD.md | Reproducible build verification |
| audit/AUDIT_SCOPE.md | Security audit scope |
| audit/AUDIT_CHECKLIST.md | Audit checklist |
| audit/KNOWN_ISSUES.md | Known issues tracker |
| audit/ARCHITECTURE.md | Architecture document for auditors |
| audit/FINDINGS_TRACKER.md | Audit findings tracker |
| Document | Description |
|---|---|
| PRODUCTION_READINESS_REPORT.md | Production readiness assessment |
| PRODUCTION_READINESS_CHECKLIST.md | Pre-mainnet checklist |
| ROLLBACK_RUNBOOK.md | Rollback procedures |
| DATA_INVENTORY.md | Data inventory and retention policy |
| ISSUES.md | Issue tracker (SR-series) |
| Document | Description |
|---|---|
| implementation/IMPLEMENTATION_SUMMARY.md | Overall implementation summary |
| implementation/BATCH_REMITTANCE.md | Batch remittance implementation |
| implementation/ABUSE_PROTECTION.md | Abuse protection implementation |
| implementation/PROOF_OF_PAYOUT.md | Proof-of-payout implementation |
| implementation/CURRENCY_API.md | Currency API implementation |
| implementation/TRANSACTION_CONTROLLER_IMPL.md | Transaction controller implementation notes |
| Document | Description |
|---|---|
| ANCHOR_QUICKSTART.md | SEP-24 anchor quick-start |
| ANCHOR_SELECTION.md | Anchor selection guide |
| STELLAR_WALLETS_KIT.md | Stellar Wallets Kit React integration guide |
| MOBILE_FEATURE_PARITY.md | Mobile feature parity status |
| Document | Description |
|---|---|
| design/login-ui.md | Login UI design |
| design/landing-page.md | Landing page design |
| design/settings-ui.md | Settings UI design |
| design/color-palette.md | Color palette |
| UI_DESIGN.md | UI design overview |
Only these files are permitted at the repository root:
README.md— project overview and quick-startCONTRIBUTING.md— contributor guideSECURITY.md— security policy and disclosure processCHANGELOG.md— release changelogROADMAP.md— shipped features and planned work
A CI check (scripts/check-root-markdown.sh) enforces this list and fails the
build if any other .md file appears at root.