Welcome to the Ted API documentation hub! This folder contains all the documentation for the Ted mobile app backend.
- Main Project README - Project overview, setup instructions, and general information
- Source Code Documentation - Detailed documentation of the source code modules and architecture
- Refactoring Guide - Complete guide to the recent codebase refactoring
- Transcription Improvements - Documentation of audio transcription enhancements and fixes
- logo.png - Project logo and branding assets
| Document | Purpose | Audience |
|---|---|---|
| Main README | Project overview and setup | Developers, users |
| Source Code README | Technical implementation details | Developers |
| Refactoring Guide | Architecture changes and improvements | Developers, maintainers |
| Transcription Improvements | Audio processing enhancements | Developers, ML engineers |
For new developers joining the project:
- Start with: Main Project README - Get the big picture
- Then read: Source Code Documentation - Understand the codebase
- Review: Refactoring Guide - See recent improvements
- Deep dive: Transcription Improvements - Understand audio processing
This documentation index should be updated whenever:
- New documentation files are added
- Existing documentation is restructured
- Major features or changes are documented
When adding new documentation:
- Place it in this
docs/folder - Update this index with a brief description
- Follow the existing naming conventions
- Include proper headers and sections for easy navigation