From 826c8ffbf0f27b93a87da2a70ac3027630ca6b77 Mon Sep 17 00:00:00 2001 From: Canaan Date: Tue, 10 Feb 2026 07:36:52 +0000 Subject: [PATCH 1/4] Add Game Showcase Page Maintenance Guide documentation --- doc/GameShowCase.md | 53 +++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 53 insertions(+) create mode 100644 doc/GameShowCase.md diff --git a/doc/GameShowCase.md b/doc/GameShowCase.md new file mode 100644 index 0000000..ccf199f --- /dev/null +++ b/doc/GameShowCase.md @@ -0,0 +1,53 @@ +# Game Showcase Page Maintenance Guide + +> This document is intended for website administrators to help maintain the content of the Game Showcase page. + +--- + +## Page Overview + +The Game Showcase page is managed by administrators to highlight outstanding individual games. It serves as the featured section of the game library. + +## Prerequisites + +1. **Add a Game** + - Path: `/admin/game_dev/game/add/` + - Required fields: name, description, completion status, host URL, thumbnail, event, etc. + +2. **Add Game Contributors** + - Path: `/admin/game_dev/gamecontributor/add/` + - Link club members to individual games. Each contributor must first be created in the `/admin/game_dev/member/` member panel. + +## Add Game Showcase + +1. Navigate to: `/admin/game_dev/gameshowcase/add/` +2. Use the search function to find the desired game, then click the game ID to populate the value. +3. Enter the committee's recommendation in the "Description" field. +4. Save your changes and review the showcase page to ensure the content is correct. + + +## Page Elements Maintenance + +- **Game Title** + - Edit at: `/admin/game_dev/game/` + +- **Recommendation (Committee Advice)** + - Edit at: `/admin/game_dev/gameshowcase/`, under the field "Description" + - This recommendation appears directly under the game title as advice from the committee. + +- **Game Description** + - Edit at: `/admin/game_dev/game/` + - The description is shown below the cover image and contributor section, and matches the content on the individual game page. + +- **Cover Image** + - Uses the thumbnail uploaded when adding the game. + - Edit at: `/admin/game_dev/game/` + +- **Contributors** + - Each contributor is a website member, inheriting ID, name, and social media links from the member panel. + - Edit member info at: `/admin/game_dev/member/` + - Contributor roles can be freely assigned at `/admin/game_dev/gamecontributor/`. + +--- + + From 25a5b1e372c7b14a5f4951d055f51fc07ae0435e Mon Sep 17 00:00:00 2001 From: Games4Doritos Date: Sun, 29 Mar 2026 21:19:38 +0800 Subject: [PATCH 2/4] Added Art showcase segment to showcase docs --- .../admin-dashboard}/GameShowCase.md | 47 +++++++++++++++---- 1 file changed, 37 insertions(+), 10 deletions(-) rename {doc => client/documentation/admin-dashboard}/GameShowCase.md (51%) diff --git a/doc/GameShowCase.md b/client/documentation/admin-dashboard/GameShowCase.md similarity index 51% rename from doc/GameShowCase.md rename to client/documentation/admin-dashboard/GameShowCase.md index ccf199f..36f3433 100644 --- a/doc/GameShowCase.md +++ b/client/documentation/admin-dashboard/GameShowCase.md @@ -1,10 +1,8 @@ -# Game Showcase Page Maintenance Guide +# Showcase Page Maintenance Guide -> This document is intended for website administrators to help maintain the content of the Game Showcase page. +> This document is intended for website administrators to help maintain the content of the Game and Art Showcase tables. ---- - -## Page Overview +## Game Showcase The Game Showcase page is managed by administrators to highlight outstanding individual games. It serves as the featured section of the game library. @@ -43,11 +41,40 @@ The Game Showcase page is managed by administrators to highlight outstanding ind - Uses the thumbnail uploaded when adding the game. - Edit at: `/admin/game_dev/game/` -- **Contributors** - - Each contributor is a website member, inheriting ID, name, and social media links from the member panel. - - Edit member info at: `/admin/game_dev/member/` - - Contributor roles can be freely assigned at `/admin/game_dev/gamecontributor/`. ---- +## Art Showcase + +The Art Showcase page is managed by administrators to highlight outstanding individual artworks. It serves as the featured section of the art library. + +## Prerequisites + +1. **Add an Art Object** + - Path: `/admin/game_dev/art/add/` + - Required fields: name, description, source_game, media, active + +2. **Add Art Contributors** + - Path: `/admin/game_dev/artcontributor/add/` + - Link club members to individual artworks. Each contributor must first be created in the `/admin/game_dev/member/` member panel. + +## Add Art Showcase + +1. Navigate to: `/admin/game_dev/artshowcase/add/` +2. Use the search function to find the desired art object, then click the art ID to populate the value. +3. Enter the committee's recommendation in the "Description" field. +4. Save your changes and review the showcase page to ensure the content is correct. + +## Page Elements Maintenance + +- **Art Name** + - Edit at: `/admin/game_dev/art/` + +- **Recommendation (Committee Advice)** + - Edit at: `/admin/game_dev/artshowcase/`, under the field "Description" + - This recommendation appears directly under the art name as advice from the committee. +- **Art Description** + - Edit at: `/admin/game_dev/art/` +- **Media** + - Uses the media uploaded when adding the art. + - Edit at: `/admin/game_dev/art/` \ No newline at end of file From f1c1b21079ee0b5c0473186d5e54aa8935695328 Mon Sep 17 00:00:00 2001 From: Games4Doritos Date: Sun, 29 Mar 2026 21:21:36 +0800 Subject: [PATCH 3/4] Renamed doc --- .../admin-dashboard/{GameShowCase.md => showcase.md} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename client/documentation/admin-dashboard/{GameShowCase.md => showcase.md} (100%) diff --git a/client/documentation/admin-dashboard/GameShowCase.md b/client/documentation/admin-dashboard/showcase.md similarity index 100% rename from client/documentation/admin-dashboard/GameShowCase.md rename to client/documentation/admin-dashboard/showcase.md From 0730c2a25e3f4e092416e05711611aea393bd667 Mon Sep 17 00:00:00 2001 From: samjjacko Date: Wed, 15 Apr 2026 17:27:08 +0800 Subject: [PATCH 4/4] nitpicks --- .../admin-dashboard/committee.md | 12 ++-- client/documentation/admin-dashboard/games.md | 15 +++-- .../documentation/admin-dashboard/members.md | 1 + .../documentation/admin-dashboard/showcase.md | 61 ++++++++++--------- 4 files changed, 49 insertions(+), 40 deletions(-) diff --git a/client/documentation/admin-dashboard/committee.md b/client/documentation/admin-dashboard/committee.md index 5127371..0dc6243 100644 --- a/client/documentation/admin-dashboard/committee.md +++ b/client/documentation/admin-dashboard/committee.md @@ -1,13 +1,15 @@ ## Committee Members -Profiles of the Committee Members of the club that are displayed on the about page. +URL: `/admin/game_dev/committee/add/` + +Profiles of the Committee Members of the club that are displayed on the about page `/about`. + +## Prerequisites + +As a committee member is also a member of the club, you must construct a member first via `/admin/game_dev/member/add/`. Back on the committee page, you can find a specific member (e.g. the one you just created) by clicking the magnifying glass icon next to the `Id` input box. ## 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) diff --git a/client/documentation/admin-dashboard/games.md b/client/documentation/admin-dashboard/games.md index 73caf79..a5ace97 100644 --- a/client/documentation/admin-dashboard/games.md +++ b/client/documentation/admin-dashboard/games.md @@ -1,18 +1,20 @@ ## Games +URL: `/admin/game_dev/game/` Pages for games can be added and edited at the row 'Game' of the GAME_DEV section on the main admin page. ### Fields **Name:** Required field for the game's name. A character field (includes letters, numbers and symbols) of maximum length 200 characters. -**Descripiton:** Required field for the game's description. A text field. +**Description:** Required field for the game's description. A text field. **Completion:** Required field for the game's completion. A multichoice option field with four options including: - - "Work in progress (Unplayable)" - - "Playable - In Development" - - "Beta - Stable but not Final" - - "Completed" + +- "Work in progress (Unplayable)" +- "Playable - In Development" +- "Beta - Stable but not Final" +- "Completed" **Active:** Required field for if the game is continued to be being worked on. A boolean field. @@ -28,4 +30,5 @@ Pages for games can be added and edited at the row 'Game' of the GAME_DEV sectio **Itch Game Width:** This field is required if the playable field ID is non null. This value is gotten in a similar way to the Itch Game Embed, however for the developer it's the number after "width=" and in the page source is found after "data-width=". -**Itch Game Height:** This field is required if the playable field ID is non null. This value is gotten in a similar way to the Itch Game Embed, however for the developer it's the number after "height=" and in the page source is found after "data-height=". \ No newline at end of file +**Itch Game Height:** This field is required if the playable field ID is non null. This value is gotten in a similar way to the Itch Game Embed, however for the developer it's the number after "height=" and in the page source is found after "data-height=". + diff --git a/client/documentation/admin-dashboard/members.md b/client/documentation/admin-dashboard/members.md index f8fde6a..4984ba9 100644 --- a/client/documentation/admin-dashboard/members.md +++ b/client/documentation/admin-dashboard/members.md @@ -1,5 +1,6 @@ ## Member Profiles +URL: `/admin/game_dev/member/add/` Profiles of club members can be added and edited at the row 'Member' of the GAME_DEV section on the main admin page. ### Fields diff --git a/client/documentation/admin-dashboard/showcase.md b/client/documentation/admin-dashboard/showcase.md index 36f3433..796bad3 100644 --- a/client/documentation/admin-dashboard/showcase.md +++ b/client/documentation/admin-dashboard/showcase.md @@ -1,20 +1,17 @@ -# Showcase Page Maintenance Guide - -> This document is intended for website administrators to help maintain the content of the Game and Art Showcase tables. - ## Game Showcase - -The Game Showcase page is managed by administrators to highlight outstanding individual games. It serves as the featured section of the game library. +URL: `/admin/game_dev/gameshowcase/add/` +The Game Showcase page is managed by administrators to highlight outstanding individual games. It serves as the featured section of the game library (see `/games`). ## Prerequisites 1. **Add a Game** - - Path: `/admin/game_dev/game/add/` - - Required fields: name, description, completion status, host URL, thumbnail, event, etc. + + - Path: `/admin/game_dev/game/add/` + - Required fields: name, description, completion status, host URL, thumbnail, event, etc. 2. **Add Game Contributors** - - Path: `/admin/game_dev/gamecontributor/add/` - - Link club members to individual games. Each contributor must first be created in the `/admin/game_dev/member/` member panel. + - Path: `/admin/game_dev/gamecontributor/add/` + - Link club members to individual games. Each contributor must first be created in the `/admin/game_dev/member/` member panel. ## Add Game Showcase @@ -23,24 +20,25 @@ The Game Showcase page is managed by administrators to highlight outstanding ind 3. Enter the committee's recommendation in the "Description" field. 4. Save your changes and review the showcase page to ensure the content is correct. - ## Page Elements Maintenance - **Game Title** - - Edit at: `/admin/game_dev/game/` + + - Edit at: `/admin/game_dev/game/` - **Recommendation (Committee Advice)** - - Edit at: `/admin/game_dev/gameshowcase/`, under the field "Description" - - This recommendation appears directly under the game title as advice from the committee. + + - Edit at: `/admin/game_dev/gameshowcase/`, under the field "Description" + - This recommendation appears directly under the game title as advice from the committee. - **Game Description** - - Edit at: `/admin/game_dev/game/` - - The description is shown below the cover image and contributor section, and matches the content on the individual game page. -- **Cover Image** - - Uses the thumbnail uploaded when adding the game. - - Edit at: `/admin/game_dev/game/` + - Edit at: `/admin/game_dev/game/` + - The description is shown below the cover image and contributor section, and matches the content on the individual game page. +- **Cover Image** + - Uses the thumbnail uploaded when adding the game. + - Edit at: `/admin/game_dev/game/` ## Art Showcase @@ -49,12 +47,13 @@ The Art Showcase page is managed by administrators to highlight outstanding indi ## Prerequisites 1. **Add an Art Object** - - Path: `/admin/game_dev/art/add/` - - Required fields: name, description, source_game, media, active + + - Path: `/admin/game_dev/art/add/` + - Required fields: name, description, source_game, media, active 2. **Add Art Contributors** - - Path: `/admin/game_dev/artcontributor/add/` - - Link club members to individual artworks. Each contributor must first be created in the `/admin/game_dev/member/` member panel. + - Path: `/admin/game_dev/artcontributor/add/` + - Link club members to individual artworks. Each contributor must first be created in the `/admin/game_dev/member/` member panel. ## Add Art Showcase @@ -66,15 +65,19 @@ The Art Showcase page is managed by administrators to highlight outstanding indi ## Page Elements Maintenance - **Art Name** - - Edit at: `/admin/game_dev/art/` + + - Edit at: `/admin/game_dev/art/` - **Recommendation (Committee Advice)** - - Edit at: `/admin/game_dev/artshowcase/`, under the field "Description" - - This recommendation appears directly under the art name as advice from the committee. + + - Edit at: `/admin/game_dev/artshowcase/`, under the field "Description" + - This recommendation appears directly under the art name as advice from the committee. - **Art Description** - - Edit at: `/admin/game_dev/art/` + + - Edit at: `/admin/game_dev/art/` - **Media** - - Uses the media uploaded when adding the art. - - Edit at: `/admin/game_dev/art/` \ No newline at end of file + - Uses the media uploaded when adding the art. + - Edit at: `/admin/game_dev/art/` +