📁 Documentation Reorganized

All markdown documentation has been moved to the docs/ folder for better organization!

What Changed

Before:

turbovault-web/
├── README.md
├── LICENSE
├── API_DOCUMENTATION.md
├── DEPLOYMENT.md
├── DEPLOYMENT_CHECKLIST.md
├── DEVELOPMENT_GUIDE.md
├── GITHUB_ACTIONS_SETUP.md
├── IGDB_INTEGRATION.md
├── THEMES.md
└── ... (12+ more .md files in root)

After:

turbovault-web/
├── README.md                  # Main README (updated with new links)
├── LICENSE
│
├── docs/                      # 📁 All documentation here!
│   ├── README.md             # Documentation index
│   ├── API_DOCUMENTATION.md
│   ├── DEPLOYMENT.md
│   ├── DEPLOYMENT_CHECKLIST.md
│   ├── DEVELOPMENT_GUIDE.md
│   ├── GITHUB_ACTIONS_SETUP.md
│   ├── IGDB_INTEGRATION.md
│   ├── THEMES.md
│   └── ... (all other docs)
│
├── .github/
│   ├── workflows/
│   ├── SECRETS_SETUP.md
│   └── WHAT_TO_COMMIT.md
│
└── k8s/
    ├── README.md
    ├── GITEA_SETUP.md
    └── *.yaml

✅ All Links Updated

✅ Main README.md - Points to docs/ folder
✅ All files in docs/ - Cross-references updated
✅ Relative paths fixed:
- Same folder: [link](FILENAME.md)
- Root: [link](../README.md)
- .github: [link](../.github/FILENAME.md)
- k8s: [link](../k8s/FILENAME.md)

📖 Quick Access

Main Documentation Index: docs/README.md

Most Important Docs:

Deployment Checklist - Start here for deployment
GitHub Actions Setup - CI/CD pipeline
Development Guide - Local development
API Documentation - API reference

🎯 Why This Change?

Benefits:

✅ Cleaner root directory
✅ Easier to find documentation
✅ Standard project structure
✅ Better organization
✅ Easier to maintain

GitHub Standard: Most open-source projects keep documentation in a docs/ folder, with only README.md and LICENSE in the root.

🔗 Updated Files

The following files have been updated with new paths:

README.md - Links to docs/ folder
docs/*.md - All cross-references updated
docs/README.md - NEW: Documentation index

No code changes, only documentation organization!

✨ Everything Still Works

All documentation is accessible and all links work correctly. Just:

Visit docs/README.md for the documentation index
Or access files directly in the docs/ folder
Main README still has quick links to key documents

Ready to commit? All documentation is organized and ready for GitHub! 🚀

2.8 KiB Raw Blame History