Skip to content

Ineaweb/SmartContest

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

75 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

SmartContest - Documentation

📚 Documentation complète de SmartContest - Plateforme de gestion de concours moderne avec interface utilisateur intuitive.

🎯 Aperçu

SmartContest est une plateforme complète pour la création, la gestion et l'administration de concours en ligne. Cette documentation vous guide à travers toutes les fonctionnalités de la plateforme.

📖 Documentation

🚀 Accès rapide

Structure de la documentation

  • index.md : Page d'accueil et navigation principale
  • create-account.md : Guide pour créer un compte
  • buy-credit.md : Guide pour acheter des crédits
  • create-competition.md : Guide pour créer une nouvelle compétition
  • work-with-competition/ : Guides pour gérer une compétition
    • index.md : Index des guides de gestion
    • manage-participant.md : Gestion des participants
    • manage-area.md : Gestion des zones/terrains
    • general-configuration.md : Configuration générale
    • design-competition.md : Conception de compétition

Génération de la documentation

Pour générer la documentation HTML avec MkDocs :

cd docs
# Installation (première fois)
pip install mkdocs mkdocs-material

# Serveur de développement
mkdocs serve

# Construction pour la production
mkdocs build

La documentation générée sera disponible dans le dossier docs/site/.

Améliorations apportées à la documentation

Migration vers Markdown

  • ✅ Conversion complète du format RST vers Markdown
  • ✅ Configuration MkDocs avec thème Material
  • ✅ Navigation améliorée et responsive
  • ✅ Script PowerShell pour la gestion de la documentation

Corrections orthographiques et grammaticales

  • ✅ Correction des fautes d'orthographe (ex: "enreigrement" → "enregistrement")
  • ✅ Amélioration de la grammaire et de la syntaxe
  • ✅ Harmonisation de la terminologie technique
  • ✅ Correction de "popin" → "fenêtre contextuelle"

Amélioration de la structure

  • ✅ Conversion des titres RST vers Markdown
  • ✅ Conversion des listes et images
  • ✅ Liens internes corrigés
  • ✅ Navigation cohérente entre les sections

Amélioration de la lisibilité

  • ✅ Clarification des instructions étape par étape
  • ✅ Amélioration de la cohérence terminologique
  • ✅ Meilleure organisation des sections et sous-sections
  • ✅ Documentation plus accessible et moderne

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Packages

No packages published

Contributors 2

  •  
  •  

Languages