This page is for the Hala team. It is not in the menu, but anyone with the link can read it. Nothing here is secret: the editor itself is protected by a password.
Open the editor
Section titled “Open the editor”Go to https://docs.hala.qa/admin (it opens
/keystatic).Your browser asks for a user name and password. Ask the site owner for them. After too many wrong attempts the editor locks you out for 15 minutes.
On the left you see Home, English and العربية (Arabic). Each language has one folder per section, the same as the website menu.
Add a guide
Section titled “Add a guide”Open the section, for example English → Selling (POS), and press Add.
Fill in the form:
- Title: short and starts with a verb, e.g. Make a sale.
- File name / URL: lowercase English words with dashes, e.g.
make-a-sale. Use the same file name for the English and the Arabic guide, so the language switch links them. - Short description: one sentence; it is shown in search results and on Google.
- Status: Draft (not published), In review (published with a notice) or Published.
- Packages and Who can do this: shown as badges under the title.
- App page path: the page in the app, e.g.
/pos/create. Used for the "?" help links. - Sidebar → Order: 1 puts the guide first in its section.
Write the content. Use the + button (or type
/) to insert blocks:- Steps: insert it, then write a numbered list inside, one action per step.
- Screenshot: upload the image, write the alt text, and add highlight boxes. A box is in percent of the image: Left and Top are where the box starts, Width and Height its size, Number the label. Example: left 64, top 66, width 16, height 8.
- Show me in the app: the app path and whether to start the guided tour.
- Note box (Aside): tips, cautions and "common mistakes".
- Tabs: e.g. Desktop / Phone.
Press Save (top right).
Short clips (moving pictures)
Section titled “Short clips (moving pictures)”A clip is a few seconds of the app in motion that loops like a GIF: the mouse moves, clicks and types through the task. It plays silently while it is on screen; the reader can pause it or open it bigger.
- When: at most one clip per guide, at the top (after Before you start and the Show me in the app button), for a flow that is easier to watch than to read: a sale at the POS, a payment window, a form with several steps. Keep the screenshots for the steps; a clip never replaces them.
- How it is made: clips are recorded by the clip robot on the demo business, never by hand, so they always show the current app in both languages. Ask a developer to add a clip: they write a short script in
scripts/shots/clips/<section>/<guide>.yaml(which page, what to click and type) and runnode clips.mjs --guide <guide>. It makes the English and Arabic clip (and a phone version if asked) and never saves anything in the app. - In the editor: insert the Clip block. Clip path is the path without language and extension, e.g.
/src/assets/clips/pos/make-a-sale/sale-flow; the page shows the clip in its own language. Write the Alt text (what the clip shows) and, if you like, a Caption. - Keep a clip short (6–15 seconds) and about one task. If the app changes, re-run the robot; the guide does not change.
What happens after Save
Section titled “What happens after Save”The editor writes the page to the server. About 15 seconds after the last save the site is rebuilt, and the new version is live about a minute later. Every publish is saved as a version, so any page can be rolled back: ask a developer.
You can check the last publish at https://docs.hala.qa/admin/status. If a page has an error, the build stops, the old site stays live, and the status page shows the error so you can fix the page and save again.
Good guide checklist
Section titled “Good guide checklist”- One task per guide; the title says the task.
- Start with What you'll do and Before you start.
- One short instruction per step, with one screenshot where it helps.
- Screenshots in the same language as the guide.
- Write the Arabic guide with the same file name in the Arabic section.
- Mark placeholder images as Placeholder (TODO) until the real screenshot is ready.