Skip to content

Documentation mega issue #84

@laurenpudz

Description

@laurenpudz

Produce docs/user guide to give to the game dev club with handover.

Structure of documentation:

admin-dashboard
  events
  members
  committee
  contributors
  games
  art
  showcases
pages
  landing
  about-committee
automation - adding games automatically from itch game jams
deployment

^ above structure should go in a /documentation directory next to src and public

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

for frontend page docco

  • each page should cover what the committee need to do to change any hardcoded chunks of text or images on the page

  • so far i think only the landing page and about/committee page have sections like this

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentation

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions