-
Notifications
You must be signed in to change notification settings - Fork 0
Help Centre Guide
The Help Centre is a resource giving every user quick access to guides, tutorials, and answers to common questions without needing to leave the website or contact support staff for help. It satisfies the SRS's 3.8 Help Menu requirement: an in-product help function accessible to all users, providing help centre links, tutorials, and FAQs.
Unlike most of the rest of the app, the Help Centre has no minRole restriction, meaning every authenticated account (user, analyst, admin) can see and use it.
- Click the
?icon in the top navigation bar, next to the notification bell and the profile avatar. It's available from every page in the app once logged in. - Direct route:
/help - Page component:
project/frontend/website/src/pages/help/help.tsx
A row of cards linking straight to the pages people ask about most: Dashboard, Training, Leaderboard, Contact Support (opens a mailto: link), and Wiki & Documentation (the main wiki page). The row uses a flexible layout to aid with visibility on both wide screens and narrower ones.
Short, numbered walkthroughs for common tasks, presented as a collapsible accordion (click a title to expand it):
- How to report a phishing email
- Understanding XP and the Leaderboard
- Completing a training module
- Updating your profile and password
Each accordion item has room for screenshots. These will be added and continuously added or improved upon.
A second accordion covering common questions like XP delays, password resets, verification email issues, department comparisons, and reporting a real (non-simulated) phishing email.
- The Help Centre page itself doesn't call any backend endpoint. Hence everything is static content coupled with the frontend.
- The "Contact Support" quick link at this stage uses a placeholder address (support@tyto.co.za) matching the convention already used on the login page. This can be updated it if a real support address is set up, or if something different is preferred.
- A separate User Guide wiki page is planned; once it exists, it will be added as its own Quick Links card the same way the "Wiki & Documentation" one was added on the website.