28 lines
1.1 KiB
Markdown
28 lines
1.1 KiB
Markdown
---
|
|
paths:
|
|
- "**/*.md"
|
|
---
|
|
|
|
# Docs Markdown
|
|
|
|
## Standards de documentation
|
|
|
|
- Garder les fichiers ciblés et concis — un sujet par fichier
|
|
- Utiliser des liens relatifs entre docs (par ex. `../best-practice/claude-memory.md`), pas des URL GitHub absolues
|
|
- Inclure un lien de retour en haut des docs best-practice et reports (voir les fichiers existants pour le pattern)
|
|
- Quand tu ajoutes un nouveau concept ou rapport, mets à jour le tableau correspondant dans README.md (CONCEPTS ou REPORTS)
|
|
|
|
## Conventions de structure
|
|
|
|
- Les docs de bonnes pratiques vont dans `best-practice/`
|
|
- Les docs d'implémentation vont dans `implementation/`
|
|
- Les rapports vont dans `reports/`
|
|
- Les tips vont dans `tips/`
|
|
- Le suivi changelog va dans `changelog/<category>/`
|
|
|
|
## Formatage
|
|
|
|
- Utiliser des tableaux pour les comparaisons structurées (voir le tableau README CONCEPTS comme référence)
|
|
- Utiliser les images de badges depuis `!/tags/` pour la cohérence visuelle quand tu lies des docs best-practice ou implementation
|
|
- Garder les titres hiérarchiques — ne saute pas de niveau (par ex. ne passe pas de `##` à `####`)
|