Skip to content

Commit 4b3f5ba

Browse files
committed
doc overhaul
1 parent 60ec503 commit 4b3f5ba

77 files changed

Lines changed: 545 additions & 5934 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

CHANGELOG.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
1111
- Comprehensive contributor documentation and community resources
1212
- CODE_OF_CONDUCT.md with Contributor Covenant 2.1
1313
- CHANGELOG.md for tracking project changes
14-
- CONTRIBUTORS.md for recognizing community contributions
14+
- docs/contributors.md for recognizing community contributions
1515
- Issue templates for bug reports, feature requests, and questions
1616
- Pull request template with comprehensive checklist
1717
- Development documentation in docs/development/
@@ -52,10 +52,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
5252
## Release Notes
5353

5454
### Upcoming Features
55-
See our [GitHub Issues](https://github.com/subculture-collective/transcript-create/issues) for planned features and enhancements.
55+
See our [GitHub Issues](https://github.com/PatrickFanella/transcript-create/issues) for planned features and enhancements.
5656

5757
### Migration Guide
58-
For major version upgrades, see [MIGRATIONS.md](docs/MIGRATIONS.md) for database migration procedures.
58+
For major version upgrades, see [migrations.md](docs/migrations.md) for database migration procedures.
5959

6060
### Breaking Changes
6161
Breaking changes will be clearly marked in release notes and include migration paths.

CODE_OF_CONDUCT.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ Instances of abusive, harassing, or otherwise unacceptable behavior may be
6262
reported to the community leaders responsible for enforcement at:
6363

6464
* **Email**: <security@subculture.community>
65-
* **GitHub**: [Report via Security Advisories](https://github.com/subculture-collective/transcript-create/security/advisories/new)
65+
* **GitHub**: [Report via Security Advisories](https://github.com/PatrickFanella/transcript-create/security/advisories/new)
6666

6767
All complaints will be reviewed and investigated promptly and fairly.
6868

CONTRIBUTING.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -173,15 +173,15 @@ def upgrade() -> None:
173173
"""Apply schema changes."""
174174
# Add a new column
175175
op.add_column('videos', sa.Column('thumbnail_url', sa.String(), nullable=True))
176-
176+
177177
# Create an index
178178
op.create_index('idx_videos_thumbnail', 'videos', ['thumbnail_url'])
179179

180180
def downgrade() -> None:
181181
"""Revert schema changes."""
182182
# Drop the index
183183
op.drop_index('idx_videos_thumbnail', 'videos')
184-
184+
185185
# Drop the column
186186
op.drop_column('videos', 'thumbnail_url')
187187
```
@@ -193,10 +193,10 @@ def downgrade() -> None:
193193
```bash
194194
# Test upgrade
195195
python scripts/run_migrations.py upgrade
196-
196+
197197
# Test downgrade
198198
python scripts/run_migrations.py downgrade
199-
199+
200200
# Re-apply
201201
python scripts/run_migrations.py upgrade
202202
```
@@ -269,7 +269,7 @@ See `.github/workflows/migrations-ci.yml` for details.
269269
For detailed migration examples and templates, see:
270270

271271
- **[Migration Template Guide](alembic/MIGRATION_TEMPLATE.md)** - Comprehensive examples for all migration types
272-
- **[Production Migration Runbook](docs/PRODUCTION_MIGRATIONS.md)** - Production deployment procedures
272+
- **[Production Migration Runbook](docs/production-migrations.md)** - Production deployment procedures
273273

274274
#### Quick Examples
275275

@@ -574,7 +574,7 @@ Runs on:
574574
pytest tests/
575575
ruff check app/ worker/
576576
black --check app/ worker/
577-
577+
578578
# Frontend
579579
cd frontend
580580
npm run lint
@@ -648,7 +648,7 @@ If checks take significantly longer, please report as an issue.
648648

649649
**Start here:**
650650
1. Read our [First-Time Contributors Guide](docs/contributing/first-time.md) for a step-by-step walkthrough
651-
2. Look for issues labeled [`good first issue`](https://github.com/subculture-collective/transcript-create/labels/good%20first%20issue) - these are beginner-friendly
651+
2. Look for issues labeled [`good first issue`](https://github.com/PatrickFanella/transcript-create/labels/good%20first%20issue) - these are beginner-friendly
652652
3. Check out our [Development Setup](#development-setup) guide
653653
4. Don't hesitate to ask questions!
654654

@@ -663,15 +663,15 @@ If checks take significantly longer, please report as an issue.
663663
If you have questions or need help:
664664

665665
1. **Documentation**: Check the [README.md](README.md) and [docs/](docs/) folder
666-
2. **Existing Issues**: Search [existing issues](https://github.com/subculture-collective/transcript-create/issues) for similar questions
667-
3. **Ask a Question**: Open a [new issue](https://github.com/subculture-collective/transcript-create/issues/new/choose) with the question template
666+
2. **Existing Issues**: Search [existing issues](https://github.com/PatrickFanella/transcript-create/issues) for similar questions
667+
3. **Ask a Question**: Open a [new issue](https://github.com/PatrickFanella/transcript-create/issues/new/choose) with the question template
668668
4. **Development Questions**: Check [docs/development/](docs/development/) for architecture and code guidelines
669669

670670
We strive to respond to all questions within 48 hours. Don't be shy - there are no stupid questions!
671671

672672
## Security
673673

674-
Please review [SECURITY.md](SECURITY.md) for:
674+
Please review [docs/security.md](docs/security.md) for:
675675

676676
- Reporting security vulnerabilities
677677
- Secrets management guidelines
@@ -680,7 +680,7 @@ Please review [SECURITY.md](SECURITY.md) for:
680680

681681
## Recognition
682682

683-
All contributors are recognized in our [CONTRIBUTORS.md](CONTRIBUTORS.md) file. Your contributions, big or small, are valuable to us!
683+
All contributors are recognized in our [docs/contributors.md](docs/contributors.md) file. Your contributions, big or small, are valuable to us!
684684

685685
## License
686686

README.md

Lines changed: 26 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,11 @@
22

33
# Transcript Create
44

5-
[![Backend CI](https://github.com/subculture-collective/transcript-create/actions/workflows/backend-ci.yml/badge.svg)](https://github.com/subculture-collective/transcript-create/actions/workflows/backend-ci.yml)
6-
[![Frontend CI](https://github.com/subculture-collective/transcript-create/actions/workflows/frontend-ci.yml/badge.svg)](https://github.com/subculture-collective/transcript-create/actions/workflows/frontend-ci.yml)
7-
[![Database Migrations](https://github.com/subculture-collective/transcript-create/actions/workflows/migrations-ci.yml/badge.svg)](https://github.com/subculture-collective/transcript-create/actions/workflows/migrations-ci.yml)
8-
[![E2E Tests](https://github.com/subculture-collective/transcript-create/actions/workflows/e2e-tests.yml/badge.svg)](https://github.com/subculture-collective/transcript-create/actions/workflows/e2e-tests.yml)
9-
[![Docker Build](https://github.com/subculture-collective/transcript-create/actions/workflows/docker-build.yml/badge.svg)](https://github.com/subculture-collective/transcript-create/actions/workflows/docker-build.yml)
5+
[![Backend CI](https://github.com/PatrickFanella/transcript-create/actions/workflows/backend-ci.yml/badge.svg)](https://github.com/PatrickFanella/transcript-create/actions/workflows/backend-ci.yml)
6+
[![Frontend CI](https://github.com/PatrickFanella/transcript-create/actions/workflows/frontend-ci.yml/badge.svg)](https://github.com/PatrickFanella/transcript-create/actions/workflows/frontend-ci.yml)
7+
[![Database Migrations](https://github.com/PatrickFanella/transcript-create/actions/workflows/migrations-ci.yml/badge.svg)](https://github.com/PatrickFanella/transcript-create/actions/workflows/migrations-ci.yml)
8+
[![E2E Tests](https://github.com/PatrickFanella/transcript-create/actions/workflows/e2e-tests.yml/badge.svg)](https://github.com/PatrickFanella/transcript-create/actions/workflows/e2e-tests.yml)
9+
[![Docker Build](https://github.com/PatrickFanella/transcript-create/actions/workflows/docker-build.yml/badge.svg)](https://github.com/PatrickFanella/transcript-create/actions/workflows/docker-build.yml)
1010
[![Docker Image Version](https://ghcr-badge.egpl.dev/onnwee/transcript-create/latest_tag?trim=major&label=latest)](https://github.com/onnwee/transcript-create/pkgs/container/transcript-create)
1111
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
1212
[![Code of Conduct](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](CODE_OF_CONDUCT.md)
@@ -38,13 +38,13 @@ See the [SDK documentation](clients/) for detailed usage examples and API refere
3838

3939
- **[Getting Started Guide](docs/getting-started.md)** - Set up and run your first transcription
4040
- **[YouTube Ingestion Setup](docs/youtube-ingestion-setup.md)** - JS runtime, cookies, and troubleshooting
41-
- **[YouTube Quick Reference](docs/YOUTUBE_TROUBLESHOOTING_QUICK_REFERENCE.md)** - Fast troubleshooting for common issues
41+
- **[YouTube Quick Reference](docs/youtube-troubleshooting-quick-reference.md)** - Fast troubleshooting for common issues
4242
- **[PO Token Manager](docs/po-token-manager.md)** - Configure YouTube PO tokens for reliable downloads
4343
- **[API Documentation](docs/api-reference.md)** - Complete API reference with examples
4444
- **[Contributing Guide](CONTRIBUTING.md)** - How to contribute to the project
4545
- **[Code of Conduct](CODE_OF_CONDUCT.md)** - Community guidelines
4646
- **[Changelog](CHANGELOG.md)** - Track project changes and releases
47-
- **[Security Policy](SECURITY.md)** - Report vulnerabilities responsibly
47+
- **[Security Policy](docs/security.md)** - Report vulnerabilities responsibly
4848

4949
### For Contributors
5050

@@ -57,11 +57,11 @@ See the [SDK documentation](clients/) for detailed usage examples and API refere
5757

5858
### Get Involved
5959

60-
- 🐛 [Report a Bug](https://github.com/subculture-collective/transcript-create/issues/new?template=bug_report.md)
61-
-[Request a Feature](https://github.com/subculture-collective/transcript-create/issues/new?template=feature_request.md)
62-
-[Ask a Question](https://github.com/subculture-collective/transcript-create/issues/new?template=question.md)
63-
- 🙌 [View All Contributors](CONTRIBUTORS.md)
64-
- 🎯 [Find Good First Issues](https://github.com/subculture-collective/transcript-create/labels/good%20first%20issue)
60+
- 🐛 [Report a Bug](https://github.com/PatrickFanella/transcript-create/issues/new?template=bug_report.md)
61+
-[Request a Feature](https://github.com/PatrickFanella/transcript-create/issues/new?template=feature_request.md)
62+
-[Ask a Question](https://github.com/PatrickFanella/transcript-create/issues/new?template=question.md)
63+
- 🙌 [View All Contributors](docs/contributors.md)
64+
- 🎯 [Find Good First Issues](https://github.com/PatrickFanella/transcript-create/labels/good%20first%20issue)
6565

6666
## CI/CD Status
6767

@@ -136,7 +136,7 @@ openssl rand -hex 32 # Copy this value to SESSION_SECRET in .env
136136
# Billing/auth can be added later; see sections below
137137
```
138138

139-
**Security Note**: See [SECURITY.md](SECURITY.md) for detailed security practices and secrets management.
139+
**Security Note**: See [docs/security.md](docs/security.md) for detailed security practices and secrets management.
140140

141141
2. Start services with Docker Compose (Postgres + API + Worker + Backup; OpenSearch optional)
142142

@@ -261,11 +261,11 @@ Images are built with:
261261
- Data storage: `data/VIDEO_UUID/` mounted as `/data` in containers
262262
- OpenSearch analysis: `config/opensearch/analysis/`
263263
- Documentation: `docs/` (guides for migrations, logging, monitoring, disaster recovery, etc.)
264-
- [Database Migrations](docs/MIGRATIONS.md) - Schema versioning with Alembic
264+
- [Database Migrations](docs/migrations.md) - Schema versioning with Alembic
265265
- [Backup & Disaster Recovery](docs/operations/disaster-recovery.md) - Automated backups, PITR, recovery procedures
266266
- [Backup Operations](docs/operations/backup-operations.md) - Daily operations, troubleshooting, maintenance
267267

268-
See [docs/MIGRATIONS.md](docs/MIGRATIONS.md) for database migration details.
268+
See [docs/migrations.md](docs/migrations.md) for database migration details.
269269
See [docs/operations/disaster-recovery.md](docs/operations/disaster-recovery.md) for backup and recovery procedures.
270270

271271
## Pipeline overview
@@ -480,7 +480,7 @@ The application includes comprehensive monitoring with Prometheus metrics and Gr
480480
- Database query performance
481481
- GPU memory usage (when available)
482482

483-
For detailed documentation, see [docs/MONITORING.md](docs/MONITORING.md) including:
483+
For detailed documentation, see [docs/monitoring.md](docs/monitoring.md) including:
484484

485485
- Adding custom metrics
486486
- Alert configuration
@@ -531,7 +531,7 @@ For comprehensive troubleshooting of YouTube downloads, see **[YouTube Ingestion
531531
- **[YouTube Ingestion Setup](docs/youtube-ingestion-setup.md)** - Comprehensive setup and troubleshooting
532532
- **[PO Token Manager](docs/po-token-manager.md)** - Token configuration and troubleshooting
533533
- **[Health Checks](docs/health-checks.md)** - System health monitoring
534-
- **[Error Handling](docs/ERROR_HANDLING.md)** - Error recovery patterns
534+
- **[Error Handling](docs/error-handling.md)** - Error recovery patterns
535535

536536
## Testing
537537

@@ -611,7 +611,7 @@ npm run test:critical # Fast critical tests only
611611
- Mobile responsiveness
612612
- Cross-browser (Chromium, Firefox, WebKit)
613613

614-
See [docs/E2E-TESTING.md](docs/E2E-TESTING.md) for comprehensive guide and [e2e/README.md](e2e/README.md) for detailed documentation.
614+
See [docs/e2e-testing.md](docs/e2e-testing.md) for comprehensive guide and [e2e/README.md](e2e/README.md) for detailed documentation.
615615

616616
## Contributing
617617

@@ -689,7 +689,7 @@ For detailed guidelines, see [CONTRIBUTING.md](CONTRIBUTING.md).
689689
pip-audit -r requirements.txt
690690
```
691691

692-
4. Follow security guidelines in [SECURITY.md](SECURITY.md)
692+
4. Follow security guidelines in [docs/security.md](docs/security.md)
693693

694694
## Testing
695695

@@ -750,7 +750,7 @@ This project follows security best practices:
750750
- Pre-commit hooks prevent accidental secret commits
751751
- Secrets managed via environment variables only
752752

753-
See [SECURITY.md](SECURITY.md) for:
753+
See [docs/security.md](docs/security.md) for:
754754

755755
- Reporting security vulnerabilities
756756
- Secrets management guidelines
@@ -769,34 +769,34 @@ We follow [Semantic Versioning](https://semver.org/) (SemVer) for all releases.
769769

770770
### Release Information
771771

772-
- **Current version**: See [releases](https://github.com/subculture-collective/transcript-create/releases)
772+
- **Current version**: See [releases](https://github.com/PatrickFanella/transcript-create/releases)
773773
- **Changelog**: See [CHANGELOG.md](CHANGELOG.md) for all changes
774774
- **Release process**: See [docs/development/release-process.md](docs/development/release-process.md)
775775

776776
### Docker Image Tags
777777

778778
```bash
779779
# Specific version (recommended for production)
780-
ghcr.io/subculture-collective/transcript-create:v0.1.0
780+
ghcr.io/onnwee/transcript-create:v0.1.0
781781
782782
# Latest stable release (auto-updated)
783-
ghcr.io/subculture-collective/transcript-create:latest
783+
ghcr.io/onnwee/transcript-create:latest
784784
785785
# Major version (gets minor and patch updates)
786-
ghcr.io/subculture-collective/transcript-create:0
786+
ghcr.io/onnwee/transcript-create:0
787787
```
788788

789789
## License
790790

791791
This project is licensed under the Apache License 2.0 - see the [LICENSE](LICENSE) file for details.
792792

793-
For information about third-party dependencies and their licenses, see [THIRD_PARTY_NOTICES.md](THIRD_PARTY_NOTICES.md).
793+
For information about third-party dependencies and their licenses, see [docs/third-party-notices.md](docs/third-party-notices.md).
794794

795795
## Contributors
796796

797797
Thank you to all the amazing people who have contributed to Transcript Create! 🙏
798798

799-
See [CONTRIBUTORS.md](CONTRIBUTORS.md) for the full list of contributors.
799+
See [docs/contributors.md](docs/contributors.md) for the full list of contributors.
800800

801801
Want to contribute? Check out our [Contributing Guide](CONTRIBUTING.md) and [First-Time Contributors Guide](docs/contributing/first-time.md) to get started!
802802

0 commit comments

Comments
 (0)