docs/README.md

75 lines
1.8 KiB
Markdown
Raw Permalink Normal View History

2025-08-19 10:00:15 +00:00
# 🚀 TP Docs - Documentazione Tecnica
2025-08-19 10:00:15 +00:00
Benvenuto nel progetto **TP Docs**, il sito di documentazione ufficiale per il nostro team di sviluppo!
2025-08-19 10:00:15 +00:00
Questo progetto è costruito con [Docusaurus](https://docusaurus.io/), uno strumento moderno per creare siti di documentazione veloci, belli e facili da mantenere.
2025-08-19 10:00:15 +00:00
---
2025-08-19 10:00:15 +00:00
## 👩‍💻 Guida per gli Sviluppatori
2025-08-19 10:00:15 +00:00
Se sei uno sviluppatore, questa sezione ti spiega come collaborare in modo ordinato e sicuro usando Git e GitLab.
2025-08-19 10:00:15 +00:00
### Requisiti
2025-08-19 10:00:15 +00:00
- Git installato sul tuo computer
- Accesso al repository (chiedi al maintainer)
- Account GitLab attivo
2025-08-19 10:00:15 +00:00
### Passaggi rapidi
2025-08-19 10:00:15 +00:00
1. **Clona il repository**
2025-08-19 10:00:15 +00:00
```bash
git clone https://gitlab.tecnopackspa.it/tp-docs/tp-docs.git
cd tp-docs
```
2025-08-19 10:00:15 +00:00
2. **Crea un branch per il tuo lavoro**
2025-08-19 10:00:15 +00:00
Non lavorare mai direttamente su `master`.
2025-08-19 10:00:15 +00:00
```bash
git checkout -b feature/nome-funzionalità
```
2025-08-19 10:00:15 +00:00
3. **Modifica, committa e push**
2025-08-19 10:00:15 +00:00
Lavora sul codice, aggiungi le modifiche e crea commit chiari.
4. **Crea una Merge Request (MR)**
Spingi il branch su GitLab e apri una MR per la revisione.
---
## 📚 Documentazione Completa
Per approfondire, consulta le guide dettagliate:
- [Guida per gli sviluppatori](project_documentation/DEV_GUIDE.md)
- [Guida per i maintainer](project_documentation/MAINTAINER_GUIDE.md)
---
## 🔧 Come contribuire
Vuoi contribuire a migliorare la documentazione? Ottimo!
Segui la [guida per gli sviluppatori](project_documentation/DEV_GUIDE.md), apri una MR e partecipa alla crescita del progetto.
---
## 🌐 Sito Web
Il sito di documentazione è disponibile all'indirizzo:
[https://docs.gitlab.tecnopackspa.it](http://172.17.1.43/)
---
## 🤝 Contatti
Per supporto o domande, contatta il maintainer del progetto.
---
*Buona documentazione e buon lavoro! 🚀*