Conversation
…tdated test instructions
🔄 Auto-sync: dev → test
There was a problem hiding this comment.
Pull request overview
This PR appears to prepare the test → prod release by removing the generated phpDocumentor HTML documentation from the repository and updating the main README to point to an external documentation site.
Changes:
- Removed multiple generated documentation HTML pages under
docs/classes/ - Removed
docs/README_DOC.md(doc index + stats) - Updated
README.mdto reference external documentation and adjusted the authors list
Reviewed changes
Copilot reviewed 27 out of 169 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/classes/PHPMailer-PHPMailer-OAuthTokenProvider.html | Removes generated phpDocumentor class page from repo |
| docs/classes/PHPMailer-PHPMailer-Exception.html | Removes generated phpDocumentor class page from repo |
| docs/classes/HomeController.html | Removes generated phpDocumentor class page from repo |
| docs/classes/EmailService.html | Removes generated phpDocumentor class page from repo |
| docs/classes/Dataset.html | Removes generated phpDocumentor class page from repo |
| docs/classes/Database.html | Removes generated phpDocumentor class page from repo |
| docs/classes/Controllers-User-StudentsController.html | Removes generated phpDocumentor class page from repo |
| docs/classes/Controllers-User-ResourceListController.html | Removes generated phpDocumentor class page from repo |
| docs/classes/Controllers-User-ResourceDetailsController.html | Removes generated phpDocumentor class page from repo |
| docs/classes/Controllers-User-DashboardController.html | Removes generated phpDocumentor class page from repo |
| docs/classes/Controllers-Auth-LogoutController.html | Removes generated phpDocumentor class page from repo |
| docs/classes/Controllers-Analysis-VisualizationController.html | Removes generated phpDocumentor class page from repo |
| docs/classes/BaseController.html | Removes generated phpDocumentor class page from repo |
| docs/README_DOC.md | Removes generated documentation README/stats file |
| README.md | Points readers to external docs and updates project metadata |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| @@ -1,3 +1,5 @@ | |||
| # La liste des document d'architecture du projet StudTraj se trouve dans docs/ ainsi que liste des prompts | |||
There was a problem hiding this comment.
Typo/grammar: "document" should be plural here ("documents") to match "La liste des ...".
| # La liste des document d'architecture du projet StudTraj se trouve dans docs/ ainsi que liste des prompts | |
| # La liste des documents d'architecture du projet StudTraj se trouve dans docs/ ainsi que liste des prompts |
| @@ -1,3 +1,5 @@ | |||
| # La liste des document d'architecture du projet StudTraj se trouve dans docs/ ainsi que liste des prompts | |||
There was a problem hiding this comment.
This statement says the architecture documents (and prompts list) are in docs/, but this PR removes a large portion of docs/ (including docs/README_DOC.md). Update this line to reflect the new source of truth (e.g., link to the GitHub Pages site and/or explain how to regenerate docs locally) so the README doesn’t point to missing content.
| # La liste des document d'architecture du projet StudTraj se trouve dans docs/ ainsi que liste des prompts | |
| # La documentation d'architecture du projet StudTraj (ainsi que la liste des prompts) est disponible via le site de documentation du projet (GitHub Pages) ou peut être régénérée localement en suivant les instructions de contribution. |
| ### 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.
The README now depends on an external site as the only documented access path. If this is used in production environments with restricted outbound access (or if GitHub Pages is temporarily unavailable), documentation becomes inaccessible. Consider keeping a minimal local fallback (e.g., a short docs/README_DOC.md with generation steps) or documenting how to generate phpDocumentor output locally/via CI artifacts.
| ### 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.
This PR removes the README sections describing how to run tests and code-quality tools (phpunit/phpcs/php-cs-fixer). That makes it harder for developers/reviewers to validate changes locally. Consider restoring a brief 'Tests et qualité du code' section (or linking to a dedicated contributing doc) even if the generated API docs are hosted elsewhere.
🚀 Déploiement en Production
✅ Auto-generated tests passed on test
Cette PR a été automatiquement créée par le pipeline CI/CD après validation des tests automatiquement générés sur la branche
test.📋 Checklist de déploiement :
Créée automatiquement par GitHub Actions