C-Super / appY-Documentation

MIT License
2 stars 0 forks source link

Presentation sprint 2 #120

Closed pr0l0g closed 5 months ago

pr0l0g commented 5 months ago

Type

Documentation, Enhancement


Description


Changes walkthrough

Relevant files
Documentation
Sprint 2.md
Comprehensive Sprint 2 Presentation Documentation               

Présentation/Sprint 2.md
  • Added a comprehensive presentation for Sprint 2 including various
    sections.
  • Included slides for storytelling, user journey in nature and city,
    UI/UX design process, and deliverables.
  • Integrated images and diagrams to enhance visual understanding.
  • Detailed the UI/UX section with preliminary studies, personas,
    functionalities, and prototyping.
  • +60/-0   

    PR-Agent usage: Comment /help on the PR to get a list of all available PR-Agent tools and their descriptions

    github-actions[bot] commented 5 months ago

    PR Description updated to latest commit (https://github.com/C-Super/appY-Documentation/commit/e01189d5e41587b39bfcdca8cdcac05789b2f664)

    github-actions[bot] commented 5 months ago

    PR Review

    ⏱️ 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
    Code feedback:

    ✨ Review tool usage guide:
    **Overview:** The `review` tool scans the PR code changes, and generates a PR review which includes several types of feedbacks, such as possible PR issues, security threats and relevant test in the PR. More feedbacks can be [added](https://pr-agent-docs.codium.ai/tools/review/#general-configurations) by configuring the tool. The tool can be triggered [automatically](https://pr-agent-docs.codium.ai/usage-guide/automations_and_usage/#github-app-automatic-tools-when-a-new-pr-is-opened) every time a new PR is opened, or can be invoked manually by commenting on any PR. - When commenting, to edit [configurations](https://github.com/Codium-ai/pr-agent/blob/main/pr_agent/settings/configuration.toml#L23) related to the review tool (`pr_reviewer` section), use the following template: ``` /review --pr_reviewer.some_config1=... --pr_reviewer.some_config2=... ``` - With a [configuration file](https://pr-agent-docs.codium.ai/usage-guide/configuration_options/), use the following template: ``` [pr_reviewer] some_config1=... some_config2=... ``` See the review [usage page](https://pr-agent-docs.codium.ai/tools/review/) for a comprehensive guide on using this tool.
    github-actions[bot] commented 5 months ago

    PR Code Suggestions

    CategorySuggestions                                                                                                                                                       
    Enhancement
    Improve image path portability by using relative paths. ___ **Consider using relative paths for images that are hosted within the same repository to
    ensure 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 clear
    communication 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 external
    servers 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 uniform
    appearance 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 -- ```

    ✨ Improve tool usage guide:
    **Overview:** The `improve` tool scans the PR code changes, and automatically generates suggestions for improving the PR code. The tool can be triggered [automatically](https://pr-agent-docs.codium.ai/usage-guide/automations_and_usage/#github-app-automatic-tools-when-a-new-pr-is-opened) every time a new PR is opened, or can be invoked manually by commenting on a PR. - When commenting, to edit [configurations](https://github.com/Codium-ai/pr-agent/blob/main/pr_agent/settings/configuration.toml#L78) related to the improve tool (`pr_code_suggestions` section), use the following template: ``` /improve --pr_code_suggestions.some_config1=... --pr_code_suggestions.some_config2=... ``` - With a [configuration file](https://pr-agent-docs.codium.ai/usage-guide/configuration_options/), use the following template: ``` [pr_code_suggestions] some_config1=... some_config2=... ``` See the improve [usage page](https://pr-agent-docs.codium.ai/tools/improve/) for a comprehensive guide on using this tool.