code4romania / code4romania/sunrise

User manual [Design Done / Content in progress]

Open
#180 1 comment 0 reactions 0 assignees View on GitHub
Dominant language
PHP
Stars
0
Forks
0
Avg merge
1m
Merged PRs (30d)
1

Description

**Description:**
The User Manual of the app should be accessed via an icon button, located in the top app bar. Click on the button opens the User Manual in a **_new tab_**, so users can consult the user manual without taking them out of the context of their work.

**Design of the user manual**
The user manual is structured in sections (_i.e. Intro, Acasa, Beneficiari, Comunitatea Sunrise, etc_) and each section is structured into multiple pages (_i.e. Despre platforma SUNRISE, Cazuri si managementul de caz, etc_).
- Users can navigate between pages via the **secondary navigation component** situated on the left-hand side of the page (which is persistent across all pages and displays only Heading 1 level information - marked as H1). Clicking on any menu item will open the corresponding page.
- Within a given page, they can easily navigate between subsections using the **anchor (link) menu** on the right hand side of the page (displaying different information on each page, consistent with Heading 2 level information - marked as H2). Clicking on any menu item will scroll the page to the respective section. Similarly, scrolling through a page will be synchronised with the corresponding selections in the anchor/link menu.
- FIGMA link here: https://www.figma.com/design/gpOGCkb9B6pTfe1DvleVMm/Sunrise?node-id=8306-13434&t=lHPiiC0Cvd7YKEop-4

**User manual content** (WORK IN PROGRESS - to be used only for mock-up purposes)
https://docs.google.com/document/d/12DisUE56P18jz_JEqSn2iWi9WCeOCrSGZTzjIVgp60o/edit?tab=t.0#heading=h.khmjwr4vlhzw

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.