From 1599c51590ddba284c357ba5e7933c1d5d248568 Mon Sep 17 00:00:00 2001 From: Games4Doritos Date: Sat, 21 Feb 2026 15:52:12 +0800 Subject: [PATCH 1/2] Added Committee documentation --- client/documentation/admin-dashboard/committee.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) create mode 100644 client/documentation/admin-dashboard/committee.md diff --git a/client/documentation/admin-dashboard/committee.md b/client/documentation/admin-dashboard/committee.md new file mode 100644 index 0000000..632677b --- /dev/null +++ b/client/documentation/admin-dashboard/committee.md @@ -0,0 +1,15 @@ +## Committee Members + +Profiles of the Committee Members of the club that are displayed on the about page. + +## Fields + +**Id:** Required and unique field for the club member that is on the committee. It is an integer field that corresponds to the raw integer id of a row in the Member table, as a Foreign Key if you know databases. + +**Role:** Required and unique field for the specific role in the committee that this member has. It is something known as an Enum (Enumeration), which has a discrete number of custom choices. You can choose from 'President', 'Vice President', 'Secretary', 'Treasurer', 'Marketing', 'Events OCM', 'Projects OCM', and 'Fresher Rep'. Since they must be unique, you can only have 8 objects in the Committee table at a time for now. This can definitely be changed in the future when the committee grows. + +## Other Notes + +Before making a Committee object in the Committee table, you must make a Member object for the person that's on the committee and then link it through the id (just to clarify) + +The Committee Members are always displayed in the same order on the about page, which is the order previously mentioned. If a certain Committee object can't be retreived, a placeholder Committee Member portrait will be displayed to maintain the same order. \ No newline at end of file From 58418c9bbd2d2fba0b127509f2eb0f3246e5a548 Mon Sep 17 00:00:00 2001 From: Games4Doritos Date: Sat, 21 Feb 2026 23:44:11 +0800 Subject: [PATCH 2/2] Added about-committee documentation and guiding comments - Added documentation for the about/committee page, especially mentioning what file the hardcoded content is - Added helpful comments in about.tsx surrounding the hardcoded areas that are to be altered by the committee --- client/documentation/admin-dashboard/committee.md | 2 -- client/documentation/pages/about-committee.md | 11 +++++++++++ client/src/pages/about.tsx | 6 ++++++ 3 files changed, 17 insertions(+), 2 deletions(-) create mode 100644 client/documentation/pages/about-committee.md diff --git a/client/documentation/admin-dashboard/committee.md b/client/documentation/admin-dashboard/committee.md index 632677b..5127371 100644 --- a/client/documentation/admin-dashboard/committee.md +++ b/client/documentation/admin-dashboard/committee.md @@ -11,5 +11,3 @@ Profiles of the Committee Members of the club that are displayed on the about pa ## Other Notes Before making a Committee object in the Committee table, you must make a Member object for the person that's on the committee and then link it through the id (just to clarify) - -The Committee Members are always displayed in the same order on the about page, which is the order previously mentioned. If a certain Committee object can't be retreived, a placeholder Committee Member portrait will be displayed to maintain the same order. \ No newline at end of file diff --git a/client/documentation/pages/about-committee.md b/client/documentation/pages/about-committee.md new file mode 100644 index 0000000..38b8f54 --- /dev/null +++ b/client/documentation/pages/about-committee.md @@ -0,0 +1,11 @@ +## About/Committee Page + +Has a description of the club, it's aim's etc, along with a big feature photo, intended to be a group photo of the committee or a big event? Then below is a display of all the current committee members of the club, showing name, role and pronouns. + +## Hardcoded content to be modified by committee members + +The club description and feature photo are the only things hardcoded into the website's front-end. Starting from the root directory of this website's source, this code to modify can be found in /client/src/pages/about.tsx + +## Other Notes + +The Committee Members are always displayed in the same order on the about page, which is the order mentioned in admin-dashboard/committee.md. If a certain Committee object can't be retreived, a placeholder Committee Member portrait will be displayed to maintain the same order. \ No newline at end of file diff --git a/client/src/pages/about.tsx b/client/src/pages/about.tsx index df3e144..99bcedb 100644 --- a/client/src/pages/about.tsx +++ b/client/src/pages/about.tsx @@ -30,19 +30,25 @@ export default function AboutPage() {
>Hardcoded feature image to be altered. Only alter 'src', 'alt' is supposed to be a placeholder<<*/ src="/landing_placeholder.png" + /*>>Hardcoded feature image to be altered. Only alter 'src', 'alt' is supposed to be a placeholder<<*/ alt="/landing_placeholder.png" fill={true} />