Aggiorna e riorganizza la documentazione del progetto
- Sostituito README.md con versione avanzata e strutturata (indice, badge, quick start, deployment, troubleshooting, roadmap, credits) - Aggiunto .gitignore completo per .NET, Docker, VSCode, log, dati locali e secrets - Creato .env.example con tutte le variabili d’ambiente documentate per Docker/Unraid - Aggiunti script organize-docs.ps1/.sh per strutturare e spostare la documentazione in docs/ - Aggiornate e migliorate tutte le guide tecniche (Docker, Unraid, Git workflow, troubleshooting, verifica finale) - Documentazione ora pronta per ambienti di produzione, collaborazione e manutenzione
This commit is contained in:
31
TradingBot/organize-docs.sh
Normal file
31
TradingBot/organize-docs.sh
Normal file
@@ -0,0 +1,31 @@
|
||||
#!/bin/bash
|
||||
# Documentation Organization Script
|
||||
# Run this to organize all documentation files
|
||||
|
||||
DOCS="docs"
|
||||
|
||||
# Create directory structure
|
||||
echo "Creating directory structure..."
|
||||
mkdir -p "$DOCS"/{installation,architecture,deployment,configuration,trading,development,troubleshooting,verification,api}
|
||||
|
||||
# Move files to appropriate directories
|
||||
echo "Moving documentation files..."
|
||||
|
||||
# Deployment docs
|
||||
mv DOCKER_QUICKSTART.md "$DOCS/deployment/" 2>/dev/null
|
||||
mv UNRAID_DEPLOYMENT.md "$DOCS/deployment/" 2>/dev/null
|
||||
mv DOCKER_BUILD_TEST.md "$DOCS/deployment/" 2>/dev/null
|
||||
|
||||
# Development docs
|
||||
mv GIT_WORKFLOW.md "$DOCS/development/" 2>/dev/null
|
||||
mv COMMIT_CHECKLIST.md "$DOCS/development/" 2>/dev/null
|
||||
|
||||
# Troubleshooting docs
|
||||
mv BROWSER_CACHE_GUIDE.md "$DOCS/troubleshooting/" 2>/dev/null
|
||||
mv SIDEBAR_TOGGLE_DEBUG.md "$DOCS/troubleshooting/" 2>/dev/null
|
||||
|
||||
# Verification docs
|
||||
mv FINAL_VERIFICATION.md "$DOCS/verification/" 2>/dev/null
|
||||
|
||||
echo "? Documentation organized!"
|
||||
echo "See docs/README.md for index"
|
||||
Reference in New Issue
Block a user