v0.6.2 added help window

This commit is contained in:
2026-03-10 14:43:25 -04:00
parent 605d10ae02
commit 85cfad6318
18 changed files with 435 additions and 172 deletions

105
data/help.md Normal file
View File

@@ -0,0 +1,105 @@
# Getting Started with Jama
Welcome to **Jama** — your private, self-hosted team messaging app.
---
## Navigating Jama
### Message List (Left Sidebar)
The sidebar shows all your message groups and direct conversations. Tap or click any group to open it.
- **#** prefix indicates a **Public** group — visible to all users
- **Lock** icon indicates a **Private** group — invite only
- **Bold** group names have unread messages
- The last message preview shows **You:** if you sent it
---
## Sending Messages
Type your message in the input box at the bottom and press **Enter** to send.
- **Shift + Enter** adds a new line without sending
- Tap the **+** button to attach a photo or emoji
- Use the **camera** icon to take a photo directly (mobile)
### Mentioning Someone
Type **@** followed by the person's name to mention them. Select from the dropdown that appears. Mentioned users receive a notification.
Example: `@[John Smith]` will notify John.
### Replying to a Message
Hover over any message and click the **reply arrow** to quote and reply to it.
### Reacting to a Message
Hover over any message and click the **emoji** button to react with an emoji.
---
## Direct Messages
To start a private conversation with one person:
1. Click the **pencil / new chat** icon in the sidebar
2. Select one user from the list
3. Click **Start Conversation**
---
## Group Messages
To create a group conversation:
1. Click the **pencil / new chat** icon
2. Select two or more users
3. Enter a **Group Name**
4. Click **Create**
> If a group with the exact same members already exists, you will be redirected to it automatically.
---
## Your Profile
Click your name or avatar at the bottom of the sidebar to:
- Update your **display name** (shown to others instead of your username)
- Add an **about me** note
- Upload a **profile photo**
- Change your **password**
---
## Customising Group Names
You can set a personal display name for any group that only you will see:
1. Open the group
2. Click the **ⓘ info** icon in the top bar
3. Enter your custom name under **Your custom name**
4. Click **Save**
Other members still see the original group name.
---
## Settings
Admins can access **Settings** from the user menu to configure:
- App name and logo
- Default user password
- Notification preferences
---
## Tips
- 🌙 Toggle **dark mode** from the user menu
- 🔔 Enable **push notifications** when prompted to receive alerts when the app is closed
- 📱 Install Jama as a **PWA** on your device — tap *Add to Home Screen* in your browser menu for an app-like experience
---
*This help file can be updated by your administrator at any time.*