Entry point for docs/. Start here, then follow the links below by topic.
- contributing/setup.md — set up
contracts/,apps/backend,apps/frontend, andpackages/*locally, from a clean checkout to a running stack. Covers workspace linking/build order for everypackages/*directory. - developer-onboarding.md — broader onboarding: project structure, dev workflow, debugging tips, FAQ.
- contributor-onboarding.md — contribution process and PR checklist.
- troubleshooting-guide.md — general troubleshooting beyond local setup.
- architecture.md — system architecture overview and data-flow diagram.
- adr/ — Architecture Decision Records. Includes why the platform is split into 19 Soroban contracts instead of a monolith (ADR-006–ADR-009), tech stack choices (Stellar/Soroban, NestJS, Next.js), and token economics.
- code-organization-guide.md / code-organization-migration-guide.md — codebase layout conventions.
- mobile-architecture.md —
packages/mobile/packages/mobile-apparchitecture.
- contract-interfaces.md — full public interface reference for all 19 contract crates (functions, auth, events), cross-contract call conventions, and worked call-chain examples.
- contracts.md — contract addresses, CLI usage, and TypeScript/JavaScript integration examples.
- smart-contract-interaction-guide.md / smart-contract-upgrade-guide.md — invoking and upgrading deployed contracts.
- contract-upgrades.md — the timelocked upgrade mechanism.
- CONTRACT_SECURITY.md — contract-specific security considerations.
- contract-fuzzing-guide.md / contract-integration-testing.md — contract testing strategy, including
contracts/integration. - wasm-release.md — WASM build/release process.
- api/README.md — generated reference of every active REST route (method, path, auth) and how to regenerate the full OpenAPI spec.
- api/DEPLOYMENT.md — publishing the OpenAPI spec / Swagger UI to GitHub Pages.
- api-versioning.md / api-rate-limiting.md / api-gateway.md / api-integration-examples.md / api-documentation-automation.md — API platform concerns.
- database-schema.md / migrations.md / DATABASE_MIGRATIONS.md / database-migrations-cicd.md — data layer.
- error-handling.md / validation-guide.md / input-sanitization.md — backend conventions.
- stellar-auth.md / stellar-integration.md — how the backend talks to Stellar/Soroban.
- webhook-signatures.md / notifications-guide.md — async/event delivery.
security.md · security-guidelines.md · security-best-practices.md · security-audit.md · SECURITY_TESTING.md · CONTRACT_SECURITY.md · COMPLIANCE.md · compliance-checking.md · data-privacy-gdpr.md · kyc-verification.md · secret-management.md · secret-rotation.md · cors-policy.md · csp-implementation.md
deployment-guide.md · PRODUCTION_DEPLOYMENT.md · deployment-runbook.md · staging.md · preview-environments.md · environment-provisioning.md · environment-variables.md · docker-guide.md · monitoring.md · monitoring-observability.md · oncall-escalation.md · incident-runbook.md · disaster-recovery.md · catastrophic-recovery.md · backup-restore.md · backup-verification.md · infrastructure-validation.md · cost-optimization-implementation.md · aws-oidc.md · aws-oidc-workflow-changes.md · cdn setup
testing-strategy.md · contract-fuzzing-guide.md · contract-integration-testing.md · mutation-testing.md · pact-testing.md · test-data-management.md · load-testing.md · load-testing-guide.md · load-testing-automation.md · performance-testing-guide.md · performance-optimization.md · performance-optimization-caching.md · accessibility.md · accessibility-testing.md · accessibility-testing-guide.md · automated-accessibility-testing.md · visual-regression-testing.md · visual-regression-testing-guide.md · visual-testing-guidelines.md
analytics-guide.md · ANALYTICS.md · community-moderation.md · notifications-guide.md · i18n-guide.md · shared-types.md · dependency-injection-guide.md · dependency-injection-best-practices.md · utilities-guide.md · user-rate-limiting.md · ASSET_SUPPORT.md · scripts.md
Implementation summaries and PR description drafts from earlier development phases have been moved out of the repository root and consolidated in archive/ for posterity:
archive/ — IMPLEMENTATION_SUMMARY*.md and PR_DESC*.md files (issues #541–#841), with a dated index. These are no longer actively referenced; see merged PRs in GitHub for full context.
New to the repo? Read contributing/setup.md first, then architecture.md, then adr/README.md for the reasoning behind the current structure.