diff --git a/client/documentation/admin-dashboard.md b/client/documentation/admin-dashboard.md new file mode 100644 index 0000000..e11d488 --- /dev/null +++ b/client/documentation/admin-dashboard.md @@ -0,0 +1,63 @@ +# Admin Dashboard Documentation + +for admin dashboard docco pages: + +- each page should contain a list of the fields that need to be filled out to create a new entry and a short explanation of each +- explain any noteworthy cases where filling out a field a certain way causes a major difference on the frontend. e.g. rendering an itch widget vs a non itch widget +- for fields that need information to be filled from itch.io, a description of where to get this information from should be included +- the process for adding, managing, and removing admin accounts who can access the admin site + +## Events + +The events section of the admin dashboard allows administrators to create and manage events that will be displayed on the frontend. +Existing events will be listed in a table, and administrators can click on an event to edit its details or delete it if it is no longer relevant. +To create a new event, administrators can click on the "Add Event" button in the top right, which will take them to a form where they can fill out the necessary information about the event. + +When creating a new event, there are several fields that need to be filled out. + +### Name + +Required + +**Name:** The name of the event. This is what will be displayed on the frontend and should be descriptive enough to give users an idea of what the event is about. + +### Date and Time + +Required + +**Date:** The date and time of the event. It has two fields, **Date** and **Time**. +The **Date** field should be given in DD/MM/YYYY format, while the **Time** field should be given in HH:MM:SS format. This information is crucial for users to know when the event is taking place. + +### Description + +**Description:** A brief description of the event. This should provide users with more information about what to expect from the event and why they should attend, or alternatively what happened at the event if it is a past event. + +### Publication Date + +Required + +**Publication Date:** The date when the event was published on the frontend. This is important for users to know when the event was announced and can help them plan accordingly. + +### Cover Image + +Required + +**Cover Image:** An image that represents the event. This should be visually appealing and relevant to the event to attract users' attention. It will be displayed on the frontend alongside the event details. + +### Location + +Required + +**Location:** The location of the event. This can be a physical location or an online platform where the event will take place. Providing this information is essential for users to know where they need to go to attend the event. + +## Members + +## Committees + +## Game Contributors + +## Games + +## Art + +## Game Showcases