Skip to content

Commit 58418c9

Browse files
committed
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
1 parent 66da0fc commit 58418c9

3 files changed

Lines changed: 17 additions & 2 deletions

File tree

client/documentation/admin-dashboard/committee.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,5 +11,3 @@ Profiles of the Committee Members of the club that are displayed on the about pa
1111
## Other Notes
1212

1313
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)
14-
15-
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.
Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
## About/Committee Page
2+
3+
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.
4+
5+
## Hardcoded content to be modified by committee members
6+
7+
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
8+
9+
## Other Notes
10+
11+
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.

client/src/pages/about.tsx

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,19 +30,25 @@ export default function AboutPage() {
3030
<div className="mb-6 w-full border-t" aria-hidden="true" />
3131
<div className="space-y-4 font-sans text-base leading-relaxed text-white md:text-lg">
3232
<p>
33+
{/*>>Hardcoded description of the club to be altered<<*/}
3334
Description of the clubs aims, why it exists, its mission, etc
3435
etc. Second paragraph here, a second paragraph would be pretty
3536
cool. The more info the better yippee!!
37+
{/*>>Hardcoded description of the club to be altered<<*/}
3638
</p>
3739
<p>
40+
{/*>>Hardcoded description of the club to be altered<<*/}
3841
Lorem ipsum dolor such and such I can&apos;t remember the rest.
42+
{/*>>Hardcoded description of the club to be altered<<*/}
3943
</p>
4044
</div>
4145
</div>
4246
<div className="relative aspect-[4/3] w-full flex-shrink-0 overflow-hidden rounded-2xl bg-light_2 md:w-96 lg:w-[32rem]">
4347
<div className="flex h-full w-full items-center justify-center">
4448
<Image
49+
/*>>Hardcoded feature image to be altered. Only alter 'src', 'alt' is supposed to be a placeholder<<*/
4550
src="/landing_placeholder.png"
51+
/*>>Hardcoded feature image to be altered. Only alter 'src', 'alt' is supposed to be a placeholder<<*/
4652
alt="/landing_placeholder.png"
4753
fill={true}
4854
/>

0 commit comments

Comments
 (0)