🔄 Auto-sync: dev → test - #244
Conversation
There was a problem hiding this comment.
Pull request overview
Cette PR d’auto-sync dev → test reflète surtout un nettoyage / déplacement de la documentation générée (phpDocumentor) et une mise à jour du README pour pointer vers une documentation hébergée.
Changes:
- Suppression d’un ensemble de pages HTML générées par phpDocumentor dans
docs/classes/. - Suppression du fichier
docs/README_DOC.md(README de doc générée). - Mise à jour du
README.md(nouvelle mention versdocs/, remplacement des liens/instructions de doc et ajustements de la liste des auteurs).
Reviewed changes
Copilot reviewed 27 out of 169 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/classes/PHPMailer-PHPMailer-OAuthTokenProvider.html | Suppression d’une page de documentation générée (phpDocumentor) |
| docs/classes/PHPMailer-PHPMailer-Exception.html | Suppression d’une page de documentation générée (phpDocumentor) |
| docs/classes/HomeController.html | Suppression d’une page de documentation générée (phpDocumentor) |
| docs/classes/EmailService.html | Suppression d’une page de documentation générée (phpDocumentor) |
| docs/classes/Dataset.html | Suppression d’une page de documentation générée (phpDocumentor) |
| docs/classes/Database.html | Suppression d’une page de documentation générée (phpDocumentor) |
| docs/classes/Controllers-User-StudentsController.html | Suppression d’une page de documentation générée (phpDocumentor) |
| docs/classes/Controllers-User-ResourceListController.html | Suppression d’une page de documentation générée (phpDocumentor) |
| docs/classes/Controllers-User-ResourceDetailsController.html | Suppression d’une page de documentation générée (phpDocumentor) |
| docs/classes/Controllers-User-DashboardController.html | Suppression d’une page de documentation générée (phpDocumentor) |
| docs/classes/Controllers-Auth-LogoutController.html | Suppression d’une page de documentation générée (phpDocumentor) |
| docs/classes/Controllers-Analysis-VisualizationController.html | Suppression d’une page de documentation générée (phpDocumentor) |
| docs/classes/BaseController.html | Suppression d’une page de documentation générée (phpDocumentor) |
| docs/README_DOC.md | Suppression du README de documentation générée |
| README.md | Mise Ă jour des pointeurs de documentation et ajustements de contenu (auteurs, liens) |
đź’ˇ Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| # La liste des document d'architecture du projet StudTraj se trouve dans docs/ ainsi que liste des prompts | ||
|
|
||
| # đź“Š StudTraj - Student Trajectory Analysis Platform | ||
|
|
There was a problem hiding this comment.
Le nouveau titre en tête de README contient plusieurs problèmes de formulation (ex. « document » → « documents », « se trouve » → « se trouvent », manque de déterminants) et crée un 2ᵉ H1 avant le titre principal du projet, ce qui nuit à la structure Markdown. Suggestion (obligatoire): remplacer ce H1 par une phrase dans une section existante (ou un sous-titre) et corriger la formulation, par ex. une phrase du type « Les documents d’architecture et la liste des prompts sont disponibles dans le dossier docs/. »
| # La liste des document d'architecture du projet StudTraj se trouve dans docs/ ainsi que liste des prompts | |
| # đź“Š StudTraj - Student Trajectory Analysis Platform | |
| # đź“Š StudTraj - Student Trajectory Analysis Platform | |
| Les documents d’architecture et la liste des prompts sont disponibles dans le dossier `docs/`. |
| ### Documentation technique | ||
| La documentation complète du code est générée automatiquement avec phpDocumentor : | ||
| - Consultez [`docs/README_DOC.md`](docs/README_DOC.md) | ||
| - Ouvrez `docs/index.html` dans votre navigateur pour la documentation interactive | ||
|
|
||
| ### Statistiques du projet | ||
| - **Fichiers PHP :** 38 | ||
| - **Lignes de code :** ~4559 | ||
| - **Version PHP :** 7.4+ | ||
|
|
||
| --- | ||
| - https://enzobagnis.github.io/SAE/ | ||
|
|
There was a problem hiding this comment.
La PR supprime les fichiers de doc générés sous docs/ (dont de nombreuses pages docs/classes/*.html). Or le README ne propose plus d’alternative pour une consultation locale (ex. docs/index.html) et le lien pointe vers un site externe. Suggestion (obligatoire): préciser explicitement dans le README où la doc est générée et publiée (pipeline/branch GitHub Pages), et/ou ajouter une courte procédure pour régénérer la doc en local si les artefacts ne sont plus versionnés.
| ### Documentation technique | ||
| La documentation complète du code est générée automatiquement avec phpDocumentor : | ||
| - Consultez [`docs/README_DOC.md`](docs/README_DOC.md) | ||
| - Ouvrez `docs/index.html` dans votre navigateur pour la documentation interactive | ||
|
|
||
| ### Statistiques du projet | ||
| - **Fichiers PHP :** 38 | ||
| - **Lignes de code :** ~4559 | ||
| - **Version PHP :** 7.4+ | ||
|
|
||
| --- | ||
| - https://enzobagnis.github.io/SAE/ | ||
|
|
||
| ## 🧪 Tests et qualité du code | ||
|
|
||
| ### Lancer les tests | ||
| ```bash | ||
| vendor/bin/phpunit | ||
| ``` | ||
|
|
||
| ### VĂ©rifier le style de code | ||
| ```bash | ||
| vendor/bin/phpcs | ||
| ``` | ||
|
|
||
| ### Corriger automatiquement le style | ||
| ```bash | ||
| vendor/bin/php-cs-fixer fix | ||
| ``` | ||
|
|
||
| --- |
There was a problem hiding this comment.
Le README retirait auparavant une section « Tests et qualité du code » (commandes PHPUnit/PHPCS/php-cs-fixer). La suppression de ces instructions rend l’onboarding et la contribution plus difficiles. Suggestion (recommandée): réintroduire une section courte indiquant comment lancer les tests et les outils QA (ou pointer vers un fichier CONTRIBUTING.md si c’est déplacé ailleurs).
Synchronisation automatique dev → test
âś… Linting passed on dev
Cette PR a été automatiquement créée et mergée par le pipeline CI/CD après validation du linting sur la branche
dev.Créée et mergée automatiquement par GitHub Actions