Closed pr0l0g closed 5 months ago
PR Description updated to latest commit (https://github.com/C-Super/appY-Documentation/commit/e01189d5e41587b39bfcdca8cdcac05789b2f664)
⏱️ Estimated effort to review [1-5] | 1, because the PR mainly involves documentation updates in Markdown format, which are straightforward to review and typically do not involve complex code changes. |
🧪 Relevant tests | No |
🔍 Possible issues | No |
🔒 Security concerns | No |
Category | Suggestions |
Enhancement |
Improve image path portability by using relative paths.___ **Consider using relative paths for images that are hosted within the same repository toensure portability and avoid broken links if the repository structure changes.** [Présentation/Sprint 2.md [17]](https://github.com/C-Super/appY-Documentation/pull/120/files#diff-d722f465a1f98d570c92ccb1192bc01469a8b4846d648d9754372d2108def595R17-R17) ```diff -![](../img/Présentation/Parcours_nature.png) +![](../../img/Présentation/Parcours_nature.png) ``` |
Remove empty list items for clarity.___ **Remove the empty bullet point to clean up the list and avoid confusion.** [Présentation/Sprint 2.md [41]](https://github.com/C-Super/appY-Documentation/pull/120/files#diff-d722f465a1f98d570c92ccb1192bc01469a8b4846d648d9754372d2108def595R41-R41) ```diff - Maquettage Figma -- ``` | |
Clarify ambiguous statements for better communication.___ **Clarify the ambiguous statement about application delivery time to ensure clearcommunication to stakeholders.** [Présentation/Sprint 2.md [58]](https://github.com/C-Super/appY-Documentation/pull/120/files#diff-d722f465a1f98d570c92ccb1192bc01469a8b4846d648d9754372d2108def595R58-R58) ```diff -^ On peut pas fournir une application fonctionnelle en 5 semaines.. +^ Il n'est pas possible de fournir une application pleinement fonctionnelle en seulement 5 semaines. ``` | |
Maintainability |
Replace external image URLs with local repository paths.___ **Avoid using external URLs for images in documentation to reduce dependency on externalservers and ensure availability even if the external server is down.** [Présentation/Sprint 2.md [48]](https://github.com/C-Super/appY-Documentation/pull/120/files#diff-d722f465a1f98d570c92ccb1192bc01469a8b4846d648d9754372d2108def595R48-R48) ```diff -![inline](https://cdn.discordapp.com/attachments/1220740796916170793/1227252783334555719/20240409_154402.jpg?ex=6627bb38&is=66154638&hm=e24b6225aa042104f664671ae33816e2494468fe85d45dc09781d4defcd4c584&) +![inline](../img/external/20240409_154402.jpg) ``` |
Best practice |
Ensure consistent formatting in list items.___ **Use consistent formatting for list items to improve readability and maintain a uniformappearance in the document.** [Présentation/Sprint 2.md [36-41]](https://github.com/C-Super/appY-Documentation/pull/120/files#diff-d722f465a1f98d570c92ccb1192bc01469a8b4846d648d9754372d2108def595R36-R41) ```diff - Études préliminaires - Personas - Fonctionnalités - Prototype papier - Maquettage Figma -- ``` |
Type
Documentation, Enhancement
Description
Changes walkthrough
Sprint 2.md
Comprehensive Sprint 2 Presentation Documentation
Présentation/Sprint 2.md
sections.
UI/UX design process, and deliverables.
functionalities, and prototyping.