# Documentation Index

Welcome to the Downlink documentation! This directory contains comprehensive documentation for the YouTube downloader application.

## Documentation Files

### Getting Started
- **[Setup Guide](./setup.md)** - Installation, configuration, and troubleshooting
- **[README.md](../README.md)** - Project overview and quick start

### Feature Documentation
- **[YouTube Downloader](./youtube-downloader.md)** - Core download feature documentation
- **[Transcoding](./transcoding.md)** - Format conversion and transcoding details
- **[Features](./features.md)** - Complete feature list and roadmap

### Technical Documentation
- **[API Documentation](./api.md)** - API endpoints, requests, and responses
- **[Architecture](./architecture.md)** - System architecture and design decisions
- **[Configuration](./configuration.md)** - Environment variables and configuration options

### Contributing
- **[Agent Instructions](./AGENTS.md)** - Guidelines for documenting new features

## Quick Links

### For Users
- Start with the [Setup Guide](./setup.md)
- Learn about features in [Features](./features.md)
- Check [YouTube Downloader](./youtube-downloader.md) for usage details

### For Developers
- Read [Architecture](./architecture.md) for system overview
- Check [API Documentation](./api.md) for endpoint details
- Follow [Agent Instructions](./AGENTS.md) when adding features

### For Contributors
- Follow [Agent Instructions](./AGENTS.md) for documentation standards
- Update relevant docs when adding/modifying features
- Keep documentation in sync with code changes

## Documentation Standards

When adding or updating documentation:

1. **Use clear headings** - Organize content with proper markdown headings
2. **Include examples** - Provide code examples and usage scenarios
3. **Keep it updated** - Update docs when features change
4. **Be comprehensive** - Cover overview, usage, technical details, and examples
5. **Link related docs** - Cross-reference related documentation

## Document Structure Template

Each feature document should include:

```markdown
# Feature Name

## Overview
Brief description

## Usage
How to use

## Technical Details
Implementation details

## Configuration
Settings and options

## Examples
Code examples

## Limitations
Known limitations

## Future Improvements
Planned enhancements
```

## Need Help?

- Check the [Setup Guide](./setup.md) for installation issues
- Review [Architecture](./architecture.md) for system understanding
- See [API Documentation](./api.md) for endpoint details