README.md

TipTune Documentation Index

This directory is the primary entry point for repository documentation. Start here when you need product context, contributor setup steps, or subsystem-specific references.

Core entry points

• Repository overview
• Backend guide
• Contracts guide
• Frontend guide

Backend docs

• Backend API documentation
• Backend testing guide
• Developer onboarding
• Rate limiting overview
• Compression measurements
• Waveform architecture

Smart contract docs

• Contracts overview
• Contracts quickstart
• Contracts testing and linting guide
• Contributor checklist
• Implementation notes

Frontend docs

• Frontend setup
• Wallet integration
• Wallet UX guide
• Accessibility notes

Naming notes

• backend/api-documentation.md is the normalized backend API doc path.
• backend/api -documentation.md remains as a compatibility stub and redirects readers to the normalized file.