Adding design documentation

This commit is contained in:
April Eaton 2026-01-09 18:49:31 +01:00
parent 57a63c6daa
commit 0ab2b91c40
Signed by: AprilEaton
GPG key ID: 0BCF829D48AE5C9D
2 changed files with 42 additions and 0 deletions

26
PAGES.md Normal file
View file

@ -0,0 +1,26 @@
# Page Structure
## `/`
Main page, will show the testing version for logged out users and the normal
version for logged in users. Alias for `/test` for logged out users and `/play`
for logged in ones.
## `/about`
A description of the game, safety considerations, and a link to the repository.
## `/user`
Configuration page for the user. This is where custom meals, as well as setting
the max fast duration (up to 3 days, defaulting to 1 day) can be set. Will
redirect to the login page for logged out users.
## `/test`
Testing area for the game. Will be the equivalent to what logged out users will
see, and will be a hidden url for logged in users.
## `/play`
Hosts the main game. For logged in users, this is the same as `/`. For logged
out users, this will redirect to the login page.
## `/login`
Basic login page. Allows for logged out users to log in, and will ask a logged
in user if they would like to switch accounts (log out).