Skip to content

#0 - chore(readme): Updating the ReadMe#300

Merged
LiamDaigle merged 9 commits intodevfrom
0/update_readme_
Apr 11, 2025
Merged

#0 - chore(readme): Updating the ReadMe#300
LiamDaigle merged 9 commits intodevfrom
0/update_readme_

Conversation

@im-samwong
Copy link
Copy Markdown
Collaborator

Description:

This PR updates the README to streamline the application setup instructions and add a section for bug reports and feature requests.

Changes:

  • Updated the Running the Application section:
    • Now uses docker compose up -d --pull always for ensuring the latest images.
    • Added guidance on managing the app via Docker Desktop.
    • Clarified how to manually update images using docker compose pull.
  • Added a Bug Reports & Feature Requests section with a direct link to GitHub issue creation.

Why?

  • Makes setup more efficient and user-friendly.
  • Encourages easy issue reporting and feature requests.

LiamDaigle
LiamDaigle previously approved these changes Mar 18, 2025
Copy link
Copy Markdown
Contributor

@LiamDaigle LiamDaigle left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nice

lo-vil
lo-vil previously approved these changes Mar 19, 2025
Copy link
Copy Markdown
Collaborator

@lo-vil lo-vil left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nicely done

XavierGuertin
XavierGuertin previously approved these changes Mar 19, 2025
@GetGabed
Copy link
Copy Markdown
Contributor

Hey, is there a way to make the Release, Team members and test files collapsible? It would greatly improve readability.

@PFratt
Copy link
Copy Markdown
Collaborator

PFratt commented Mar 22, 2025

Hey, is there a way to make the Release, Team members and test files collapsible? It would greatly improve readability.

@im-samwong it can be done like this:

<details>
<summary>Team Members</summary>

table
</details>
Team Members
Name Student ID GitHub ID Email Address
Wong, Samuel 40209013 im-samwong samuel.wong60@gmail.com
Dubois, Gabriel 40209252 Adissuu gabrieldubois.eng@gmail.com
Hilout, Yasmine 40214158 yasminehilout yasminehilout@gmail.com
Fetanat, Ali 40158208 Fetyali7 fetyali7@gmail.com
Frattolillo, Philip 40192245 PFratt phil.fratt@gmail.com
Villemure, Louis 40210315 lo-vil louis.villemure@gmail.com
Daigle, Liam 40207583 LiamDaigle liam.daigle@gmail.com
Keating, Kade 40166656 Kadestery kadekeating@gmail.com
Cheng, Justin 40210279 justncheng chengjustin2002@gmail.com
Guertin, Xavier 40213525 XavierGuertin xavierguertin@gmail.com
Oliel, Eden 40211989 eo2000 olieleden0@gmail.com

@LiamDaigle LiamDaigle dismissed stale reviews from XavierGuertin, lo-vil, and themself via 2a2f127 March 28, 2025 18:38
@im-samwong
Copy link
Copy Markdown
Collaborator Author

We should gather all feedback for readme here and modify before rollout.

@Fetyali7
Copy link
Copy Markdown
Collaborator

Fetyali7 commented Apr 7, 2025

One suggestion I have is to move the project summary to the very top before the project overview. This gives users a better idea of what the project is before diving into the documentation or technical details.

@PFratt
Copy link
Copy Markdown
Collaborator

PFratt commented Apr 7, 2025

We need to modify the most important files to be in line with what we have in the release 3 demo slides. Verify this with Sam and Liam.

@GetGabed
Copy link
Copy Markdown
Contributor

GetGabed commented Apr 7, 2025

We will also need to add the link of the video itself, so I'll record it from this branch and update once we got the link, along with the most important files.

Copy link
Copy Markdown
Contributor

@LiamDaigle LiamDaigle left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm!

Copy link
Copy Markdown
Collaborator

@yasminehilout yasminehilout left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice Work!

@LiamDaigle LiamDaigle merged commit be645b5 into dev Apr 11, 2025
4 checks passed
@LiamDaigle LiamDaigle deleted the 0/update_readme_ branch April 11, 2025 02:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

9 participants