diff --git a/apiserver/docs/source/index.rst b/apiserver/docs/source/index.rst index 5de2f1f..5907af0 100644 --- a/apiserver/docs/source/index.rst +++ b/apiserver/docs/source/index.rst @@ -10,6 +10,7 @@ Spaceport Documentation :maxdepth: 2 :caption: Contents: + specs dev apioverview api diff --git a/apiserver/docs/source/specs.rst b/apiserver/docs/source/specs.rst new file mode 100644 index 0000000..7f769b7 --- /dev/null +++ b/apiserver/docs/source/specs.rst @@ -0,0 +1,99 @@ +Feature Specs +============= + +This is an outline of current and future features of Spaceport. + +Plain + Implemented + +Bold + Not yet implemented + + +Web Client +---------- + +- Home + + - Login + - Sign up + + - Register a new account + - Claim an old account on the portal + - Profile + + - Photo + - Status + - Details + - Application forms + - Latest transactions + - Quick links + - Stats + + - Next meetings + - Member counts + - **Bay temperatures** +- Account settings + + - Edit member details + - Change password + - Log out from everywhere + - **Add custom CSS** +- Transactions + + - View list of transactions + - View transaction details + - Report an error in transaction + - Admins can edit transactions + +- Training + + - View list of training +- Cards + + - View list of access cards +- Member list + + - Search for members by name + - View member photo, status, and joined date +- Admin member details + + - View all of a member's details + - Edit member details + - Make member an instructor + - Pause / unpause member + - View member's application forms + - View member cards + - Edit member cards + - View member transactions + - Edit member transactions +- Course list + + - View list of courses + - View course details + - View list of classes for a course + +- Instructor course list + + - Add a new course + - Edit course details + - Create a class for a course +- Class list + + - View upcoming classes + - View recent classes + - View class details + - Sign up for a course + - Pay for course with paypal + - Withdraw from a course +- Instructor class list + + - Edit class details + - **Add a custom note for a class** + - Mark off students' attendance +- Admin Transaction list + + - View reported transactions + - Correct reported transactions + - **View all transactions by month** +