C-Super / appY-Documentation

MIT License
2 stars 0 forks source link

Merge main into calendar #160

Closed kuasar-mknd closed 5 months ago

kuasar-mknd commented 5 months ago

Type

enhancement, documentation, other


Description


Changes walkthrough

Relevant files
Enhancement
5 files
Postes.md
Add Game Scenarios and QR Code Details for City Exploration Game

Parcours/ville/Postes.md
  • Added detailed game scenarios and QR code placements for a city
    exploration game involving multiple posts.
  • Each post includes child and parent clues, QR code locations, and
    interactive game elements.
  • Enhanced storytelling elements to engage participants throughout the
    game.
  • +168/-0 
    Quantitatif.md
    Implement Quantitative Survey for Market Research               

    Étude de marché/Questionnaire/Quantitatif/Quantitatif.md
  • Provided a link to a Google Forms survey for quantitative analysis.
  • Detailed the structure and purpose of the quantitative questionnaire
    aimed at understanding family habits and technology use.
  • Included demographic analysis and preferences for mobile app
    technologies among families.
  • +77/-0   
    benchmark.md
    Enhance Benchmark Analysis with Detailed Comparisons and Insights

    benchmark/benchmark.md
  • Updated the benchmark analysis with detailed comparisons of similar
    applications and functionalities.
  • Added insights into gamification features and user interaction methods
    from various apps.
  • Enhanced the benchmark with visual aids and links to external
    resources for deeper analysis.
  • +67/-2   
    main.js
    Implement Obsidian Plugin for Dynamic Image Caption Management

    .obsidian/plugins/image-captions/main.js
  • Implemented a plugin for Obsidian to manage image captions dynamically
    within the editor.
  • Added functionality to update captions based on image metadata and
    user settings.
  • Ensured compatibility with Obsidian's markdown rendering process.
  • +129/-0 
    Storytelling - Cadre général.md
    Establish Framework for Storytelling in Guided Tours         

    Parcours/Storytelling/Storytelling - Cadre général.md
  • Established a general framework for storytelling within the app's
    guided tours.
  • Created engaging narratives to enhance user experience during the
    tours.
  • Structured the storytelling to maintain consistency across different
    tours.
  • +29/-0   
    Documentation
    5 files
    Introduction et mise en place.md
    Document Agile Project Management Practices and Tools       

    Gestion de projet/Rapport/Introduction et mise en place.md
  • Detailed the project management setup for an agile project including
    team organization and sprint planning.
  • Described the use of tools like GitHub Projects and Obsidian for task
    management and documentation.
  • Outlined daily and retrospective meeting structures to enhance team
    communication and project tracking.
  • +57/-0   
    PV Weekly 27.03.2024.md
    Record Weekly Project Meeting and Discuss Project Adjustments

    PVs/WeeklyPVs/PV Weekly 27.03.2024.md
  • Documented a weekly project meeting discussing project challenges and
    adjustments in project scope and management.
  • Highlighted the need for a detailed project specification and better
    task management.
  • Discussed the roles and responsibilities within the project team to
    improve project execution.
  • +75/-0   
    Rapport.md
    Summarize UX Research and Propose Non-Visual Interaction Techniques

    ui-ux/Rapport.md
  • Outlined preliminary UX research findings and their implications for
    app design.
  • Discussed non-visual interaction techniques to reduce screen time
    during family activities.
  • Proposed a taxonomy and ontology for organizing app content and
    improving user navigation.
  • +67/-0   
    Lettre d`intention.md
    Draft Letter of Intent for B2B Collaboration with Local Merchants

    b2b/Lettre d`intention.md
  • Drafted a letter of intent for business-to-business collaboration with
    local merchants.
  • Outlined the benefits and commitments involved in participating in the
    appY project.
  • Provided a template for merchants to express their interest and
    specify their contributions.
  • Commerçants - 1er contact.md
    Structure Initial Contact Questionnaire for Local Merchants

    b2b/Commerçants - 1er contact.md
  • Compiled a structured questionnaire for initial contact with local
    merchants.
  • Included questions to gauge merchants' perceptions of the city and
    their business challenges.
  • Aimed to assess the potential impact of the appY project on local
    commerce.
  • +22/-4   

    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/c79248476677f947b7bc2faf922509e4cb2c4f4d)

    github-actions[bot] commented 5 months ago

    PR Review

    ⏱️ Estimated effort to review [1-5] 5, due to the extensive and diverse changes across multiple files, involving both code and documentation. The PR includes modifications in project management, marketing strategies, user interaction designs, and implementation of new features in an application. This requires a detailed review of both the technical implementations and the conceptual alignment with the project's goals.
    🧪 Relevant tests No
    🔍 Possible issues Possible Bug: The mutation observer in `.obsidian/plugins/image-captions/main.js` might cause performance issues if not properly disconnected or if it triggers too frequently.
    Content Clarity: Some of the newly added documents, such as `b2b/Lettre d'intention.md`, might require clearer definitions of terms and expectations to avoid future misunderstandings with business partners.
    🔒 Security concerns No
    Code feedback:
    relevant file.obsidian/plugins/image-captions/main.js
    suggestion       Consider debouncing or throttling the mutation observer's callback to enhance performance, especially if the DOM changes frequently. This can prevent excessive computations and potential UI lag. [important]
    relevant linethis.observer.observe(document.body, { subtree: true, childList: true });


    ✨ 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                                                                                                                                                       
    Best practice
    Use const for variable declarations to ensure block scoping and avoid scope-related issues. ___ **Consider using const instead of var for defining functions and variables to ensure they
    are block-scoped, which helps in preventing accidental global variable declarations and
    other scope-related bugs.** [.obsidian/plugins/image-captions/main.js [6-12]](https://github.com/C-Super/appY-Documentation/pull/160/files#diff-7385594ef6952c8e0560e825db64a94d9e7b1dce3a744c42d19f2d4c78b5ddf6R6-R12) ```diff -var __defProp = Object.defineProperty; -var __getOwnPropDesc = Object.getOwnPropertyDescriptor; -var __getOwnPropNames = Object.getOwnPropertyNames; -var __hasOwnProp = Object.prototype.hasOwnProperty; -var __export = (target, all) => { - for (var name in all) +const __defProp = Object.defineProperty; +const __getOwnPropDesc = Object.getOwnPropertyDescriptor; +const __getOwnPropNames = Object.getOwnPropertyNames; +const __hasOwnProp = Object.prototype.hasOwnProperty; +const __export = (target, all) => { + for (const name in all) __defProp(target, name, { get: all[name], enumerable: true }); }; ```
    Use let in loops to ensure the loop variable is block-scoped. ___ **Replace the use of var with let in loops to avoid potential issues with variable hoisting
    and ensure that the loop variable is block-scoped.** [.obsidian/plugins/image-captions/main.js [10-12]](https://github.com/C-Super/appY-Documentation/pull/160/files#diff-7385594ef6952c8e0560e825db64a94d9e7b1dce3a744c42d19f2d4c78b5ddf6R10-R12) ```diff -for (var name in all) +for (let name in all) __defProp(target, name, { get: all[name], enumerable: true }); ```
    Enhancement
    Use template literals for string concatenation to enhance code readability. ___ **Use template literals for string concatenation to improve readability and maintainability
    of the code.** [.obsidian/plugins/image-captions/main.js [96]](https://github.com/C-Super/appY-Documentation/pull/160/files#diff-7385594ef6952c8e0560e825db64a94d9e7b1dce3a744c42d19f2d4c78b5ddf6R96-R96) ```diff -return "[[" + linktext + "]]"; +return `[[${linktext}]]`; ```
    Convert NodeList to an array using Array.from for better method compatibility. ___ **Use Array.from to convert NodeList to an array for better compatibility with array methods
    and improved code readability.** [.obsidian/plugins/image-captions/main.js [126]](https://github.com/C-Super/appY-Documentation/pull/160/files#diff-7385594ef6952c8e0560e825db64a94d9e7b1dce3a744c42d19f2d4c78b5ddf6R126-R126) ```diff -return child.childNodes; +return Array.from(child.childNodes); ```
    Use for...of loop with async/await for better control over asynchronous operations. ___ **Consider using async/await consistently in asynchronous functions for better readability
    and error handling.** [.obsidian/plugins/image-captions/main.js [102-106]](https://github.com/C-Super/appY-Documentation/pull/160/files#diff-7385594ef6952c8e0560e825db64a94d9e7b1dce3a744c42d19f2d4c78b5ddf6R102-R106) ```diff -el.findAll("img:not(.emoji)").forEach(async (img) => { +for (const img of el.findAll("img:not(.emoji)")) { const captionText = getCaptionText(img); const parent = img.parentElement; if (parent && (parent == null ? void 0 : parent.nodeName) !== "FIGURE" && captionText && captionText !== img.getAttribute("src")) { await insertFigureWithCaption(img, parent, captionText, ctx.sourcePath, plugin); } -}); +} ```
    Improve sentence clarity and conciseness. ___ **Consider revising the sentence structure for clarity and conciseness. The current phrasing
    is somewhat redundant and could be streamlined for better readability.** [Marketing/Guide pour la communication.md [7]](https://github.com/C-Super/appY-Documentation/pull/160/files#diff-5c98f0ecc5cc04345fa1b88340af7441369b28ac8af08259d292f091165e5b5aR7-R7) ```diff -Nous souhaitons parler avec un ton encourageant et enthousiaste en laissant libre choix à l’enfant. +Nous adoptons un ton encourageant et enthousiaste, laissant le choix libre à l’enfant. ```
    Enhance description for clearer communication strategy. ___ **Consider using more specific language to enhance the description of the interaction
    between the mascots and the children.** [Marketing/Guide pour la communication.md [42]](https://github.com/C-Super/appY-Documentation/pull/160/files#diff-5c98f0ecc5cc04345fa1b88340af7441369b28ac8af08259d292f091165e5b5aR42-R42) ```diff -Techniquement : Violette et Brumus en intéraction, bulles de textes simples et en “tu”. +Techniquement : Violette et Brumus interagissent directement avec les enfants à travers des bulles de texte simples et personnalisées. ```
    Improve text flow and reduce redundancy. ___ **To avoid redundancy and improve the flow of the text, consider merging these two sentences
    into one.** [Marketing/Guide pour la communication.md [36]](https://github.com/C-Super/appY-Documentation/pull/160/files#diff-5c98f0ecc5cc04345fa1b88340af7441369b28ac8af08259d292f091165e5b5aR36-R36) ```diff -C’est la communication hors ligne qui va atteindre les enfants principalement (affiches, bus, merch, stands, magazines et secondairement les émissions tv/radio mais à plus petite portée). +La communication hors ligne, principalement via affiches, bus, merchandising, stands, et magazines, ainsi que secondairement via émissions TV/radio, atteindra surtout les enfants. ```
    Improve consistency in participant naming conventions. ___ **Consider using a consistent naming convention for all participants. For example, use full
    names for all or just first names for all to maintain consistency and professionalism in
    the document.** [PVs/WeeklyPVs/PV Weekly 27.03.2024.md [3-4]](https://github.com/C-Super/appY-Documentation/pull/160/files#diff-e4510ed678b3397a018a4ecc4d21e151a5ef881976eb74bc00e45e51200ecf22R3-R4) ```diff Présences: Nicolas, Patrick, Marine, Laura, Cassandre, Caroline, Myriam, Karen, Joris -À distance: Miguel, Rossiny, Cassandre, Vincent +À distance: Miguel, Rossiny, Vincent ```
    Add interactive elements to the storytelling to enhance engagement. ___ **To enhance the narrative and maintain engagement, consider adding more interactive
    elements or visual aids within the storytelling sections.** [Parcours/Storytelling/Storytelling - Cadre général.md [14]](https://github.com/C-Super/appY-Documentation/pull/160/files#diff-4280c66ea8d52c7c59a482a14a872ac3a35a2d0a3847c66606a5d4cc30fd153bR14-R14) ```diff -Les familles affrontent des situations loufoques causées par les sorts de Brumus, comme des lampadaires qui dansent, des bancs qui racontent des blagues ou encore des fontaines qui crachent du chocolat chaud. +Les familles affrontent des situations loufoques causées par les sorts de Brumus, comme des lampadaires qui dansent, des bancs qui racontent des blagues ou encore des fontaines qui crachent du chocolat chaud. Chaque situation pourrait inclure une petite illustration ou un QR code menant à une animation représentant l'effet magique. ```
    Add a conclusion to reinforce the story's moral. ___ **Consider adding a summary or conclusion section at the end of the storytelling to
    reinforce the moral or lesson of the story, providing a clear takeaway for the readers.** [Parcours/Storytelling/Storytelling - Cadre général.md [18]](https://github.com/C-Super/appY-Documentation/pull/160/files#diff-4280c66ea8d52c7c59a482a14a872ac3a35a2d0a3847c66606a5d4cc30fd153bR18-R18) ```diff -Brumus, reconnaissant envers les familles et conscient de ses erreurs, promet de travailler dur pour maîtriser sa magie et devenir, un jour peut-être, un sorcier aussi compétent que la professeure Violette. +Brumus, reconnaissant envers les familles et conscient de ses erreurs, promet de travailler dur pour maîtriser sa magie et devenir, un jour peut-être, un sorcier aussi compétent que la professeure Violette. En conclusion, cette aventure montre l'importance de la persévérance et de l'apprentissage continu. ```
    Correct a spelling mistake in the French word for "toad". ___ **Consider revising the spelling of "crapeau" to "crapaud" to correct the typo in the French
    word for "toad".** [Parcours/ville/Postes.md [21]](https://github.com/C-Super/appY-Documentation/pull/160/files#diff-60f6d9cb66d33a6257679d61aebf75a9bf6f579c0d02841bd561b3a83627ee7fR21-R21) ```diff -Chat - aigle - crapeau - vache +Chat - aigle - crapaud - vache ```
    Improve the naturalness of a French expression. ___ **Replace "je me suis d’un coup senti très triste" with "je me suis soudain senti très
    triste" for a more natural expression in French.** [Parcours/ville/Postes.md [59]](https://github.com/C-Super/appY-Documentation/pull/160/files#diff-60f6d9cb66d33a6257679d61aebf75a9bf6f579c0d02841bd561b3a83627ee7fR59-R59) ```diff -Picatso : No hélas je n’ai aucune idée de qui pourrait voler la pierre par contre ce matin en allant au Parc du Castrum je me suis d’un coup senti très triste que j’en ai même perdu mon inspiration. +Picatso : No hélas je n’ai aucune idée de qui pourrait voler la pierre par contre ce matin en allant au Parc du Castrum je me suis soudain senti très triste que j’en ai même perdu mon inspiration. ```
    Bug
    Correct grammatical error to match verb with plural subject. ___ **Correct the grammatical error by changing "utilise" to "utilisent" to match the plural
    subject "Les campagnes".** [Marketing/Guide pour la communication.md [19]](https://github.com/C-Super/appY-Documentation/pull/160/files#diff-5c98f0ecc5cc04345fa1b88340af7441369b28ac8af08259d292f091165e5b5aR19-R19) ```diff -RS : Les campagnes sur Instagram et Facebook utilise un vocabulaire positif exprimant les bénéfices pour les parents et les enfants des balades dans le monde de Violette et Brumus. +RS : Les campagnes sur Instagram et Facebook utilisent un vocabulaire positif exprimant les bénéfices pour les parents et les enfants des balades dans le monde de Violette et Brumus. ```
    Remove duplicate names from the attendance list. ___ **Remove duplicate mention of "Cassandre" in the "À distance" list to avoid confusion and
    ensure accurate representation of attendance.** [PVs/WeeklyPVs/PV Weekly 27.03.2024.md [4]](https://github.com/C-Super/appY-Documentation/pull/160/files#diff-e4510ed678b3397a018a4ecc4d21e151a5ef881976eb74bc00e45e51200ecf22R4-R4) ```diff -À distance: Miguel, Rossiny, Cassandre, Vincent +À distance: Miguel, Rossiny, Vincent ```
    Fix a grammatical gender agreement error in French. ___ **Replace "verte" with "vert" to correct the gender agreement error in French, as "écran" is
    masculine.** [Parcours/ville/Postes.md [39]](https://github.com/C-Super/appY-Documentation/pull/160/files#diff-60f6d9cb66d33a6257679d61aebf75a9bf6f579c0d02841bd561b3a83627ee7fR39-R39) ```diff -L’écran devient verte/vibre/valide la direction cela le prochain dialogue de Piou-piou. +L’écran devient vert/vibre/valide la direction cela le prochain dialogue de Piou-piou. ```
    Correct a plural agreement error in French. ___ **Replace "toute les cases" with "toutes les cases" to correct the plural agreement in
    French.** [Parcours/ville/Postes.md [87]](https://github.com/C-Super/appY-Documentation/pull/160/files#diff-60f6d9cb66d33a6257679d61aebf75a9bf6f579c0d02841bd561b3a83627ee7fR87-R87) ```diff -Puzzle coulissant en bois de 4x4 avec un emplacement vide. Toute les cases sont de la même couleur sauf un qui est rouge. +Puzzle coulissant en bois de 4x4 avec un emplacement vide. Toutes les cases sont de la même couleur sauf une qui est rouge. ```
    Correct a plural form error in French. ___ **Replace "je vais avoir besoin de votre aide... enfin c’est plutôt lui qui va en avoir
    besoins" with "je vais avoir besoin de votre aide... enfin c’est plutôt lui qui va en
    avoir besoin" to correct the plural form error in French.** [Parcours/ville/Postes.md [4]](https://github.com/C-Super/appY-Documentation/pull/160/files#diff-60f6d9cb66d33a6257679d61aebf75a9bf6f579c0d02841bd561b3a83627ee7fR4-R4) ```diff -Professeur Violette la castorette apparait : Bonjour les amis je vais avoir besoin de votre aide... enfin c’est plutôt lui qui va en avoir besoins. +Professeur Violette la castorette apparait : Bonjour les amis je vais avoir besoin de votre aide... enfin c’est plutôt lui qui va en avoir besoin. ```
    Maintainability
    Use bullet points for clarity and consistency in listing items. ___ **To enhance readability and maintain a consistent format, consider using bullet points for
    the list of lexical fields.** [Marketing/Guide pour la communication.md [13]](https://github.com/C-Super/appY-Documentation/pull/160/files#diff-5c98f0ecc5cc04345fa1b88340af7441369b28ac8af08259d292f091165e5b5aR13-R13) ```diff -Champs lexical : aventure, parcours, balade, promenade, amis, Violette, Brumus, ensemble, aide /entraide, énigme, sort, sortilège. +Champs lexical : +- aventure +- parcours +- balade +- promenade +- amis +- Violette +- Brumus +- ensemble +- aide / entraide +- énigme +- sort +- sortilège ```
    Readability
    Enhance readability by breaking down long paragraphs into bullet points. ___ **Consider breaking down the long paragraph into bullet points or smaller paragraphs to
    enhance readability and clarity.** [PVs/WeeklyPVs/PV Weekly 27.03.2024.md [7]](https://github.com/C-Super/appY-Documentation/pull/160/files#diff-e4510ed678b3397a018a4ecc4d21e151a5ef881976eb74bc00e45e51200ecf22R7-R7) ```diff -Joris Retour sur le meeting de ce matin. Il s'est fait défoncer... On a pas la bonne perspective sur le projet. Mais le travail fait est pertinent! Il faut qu'on fasse attention, le cahier des charges donné n'est pas le cahier des charges final. Ils s'attendent à ce qu'on questionne tout et qu'on le redéfinisse nous même. +- Joris: Retour sur le meeting de ce matin. Il s'est fait défoncer... +- Perspective: On n'a pas la bonne perspective sur le projet. +- Cahier des charges: Le travail fait est pertinent, mais le cahier des charges donné n'est pas final. Ils s'attendent à ce qu'on questionne tout et qu'on le redéfinisse nous-même. ```

    ✨ 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.