Des tonnes de modifications notamment VIM / Couleurs / typos
This commit is contained in:
47
docs/README.md
Normal file
47
docs/README.md
Normal file
@ -0,0 +1,47 @@
|
||||
# Documentation
|
||||
|
||||
Ce dossier contient la documentation détaillée des fonctionnalités de Project Notes.
|
||||
|
||||
## Guides Disponibles
|
||||
|
||||
### [DAILY_NOTES.md](./DAILY_NOTES.md)
|
||||
Guide complet du système de Daily Notes :
|
||||
- Fonctionnalités et utilisation
|
||||
- Organisation des fichiers
|
||||
- Template par défaut
|
||||
- Calendrier interactif
|
||||
- Endpoints API
|
||||
- Architecture technique
|
||||
- Personnalisation et configuration avancée
|
||||
- Dépannage
|
||||
|
||||
## Documentation Principale
|
||||
|
||||
Pour la documentation générale du projet, consultez les fichiers à la racine :
|
||||
|
||||
- **[README.md](../README.md)** - Vue d'ensemble et guide de démarrage
|
||||
- **[ARCHITECTURE.md](../ARCHITECTURE.md)** - Architecture complète du système
|
||||
- **[CLAUDE.md](../CLAUDE.md)** - Guide de développement
|
||||
- **[API.md](../API.md)** - Documentation de l'API REST
|
||||
- **[CHANGELOG.md](../CHANGELOG.md)** - Historique des versions
|
||||
|
||||
## Contribuer
|
||||
|
||||
Pour ajouter de la documentation :
|
||||
|
||||
1. Créez un nouveau fichier `.md` dans ce dossier
|
||||
2. Ajoutez-le à la liste ci-dessus
|
||||
3. Référencez-le dans le README principal si nécessaire
|
||||
|
||||
## Format
|
||||
|
||||
La documentation utilise Markdown avec :
|
||||
- Titres hiérarchiques (`#`, `##`, `###`)
|
||||
- Blocs de code avec syntaxe (` ```language`)
|
||||
- Emojis pour la lisibilité (📅, 🎯, 💻, etc.)
|
||||
- Exemples concrets et cas d'usage
|
||||
- Sections de dépannage
|
||||
|
||||
---
|
||||
|
||||
**Dernière mise à jour** : 2025-01-11
|
||||
Reference in New Issue
Block a user