Help Center

The help center is TREK's built-in guide to the screen you are on. It answers "what is this?" and "how do I do that?" without leaving the app, with a picture of every step taken from TREK itself.

It is not the same thing as In-App Help, which is this wiki, rendered inside TREK at /help. The help center is the ? panel; it links into the wiki wherever the reference documentation continues.

Opening it

Click the ? (Help for this screen) in the navbar, next to the theme toggle. In Journey's Studio, which has no navbar, the same ? sits in the Studio toolbar. There is no keyboard shortcut, on purpose: it would fire while you were typing a question mark into a note.

The panel opens over the app, already on the screen you were looking at. Escape closes it, and the focus goes back to the ?. If you opened a dialog while following a guide, Escape closes that first.

The ? is a desktop control. On a phone the app does not show it.

What is in it

The panel has navigation on the left and the content on the right.

The screen you are on

The overview of a screen opens first. It carries:

the screen's name and summary, with a breadcrumb that says where it sits,
Go to , which closes the panel and takes you there,
a full-frame picture of the screen as you find it,
On this screen, a numbered list of what the screen holds and what each part does,
How do I…, a card per guide,
In the docs, the wiki pages that go deeper. A guide's link to them reads Open in Help & Docs.

A screen that has sub-screens lists them under Sub-screens, folded: the trip folds its plan columns, its panels and its tabs; Settings and the Admin panel fold their tabs; Journey folds the journal and the studio.

Guides

A guide is one task, start to finish. It opens with the goal and a chip that says how long it is, Quick, Guide or Walkthrough, then:

Steps, numbered. Each step is one sentence naming the app's own buttons and fields, with a picture beside it. The picture is framed on the thing the sentence tells you to use, ringed in your accent colour and numbered to match. A step that asks you to drag something shows both ends and an arrow between them. Click a picture to open it full size.
What you get, which says what changed, often with a picture of the result.
Good to know, the caveats: what needs an addon, what cannot be undone, what a permission hides.
Related, the guides that go with this one, and In the docs, the wiki pages behind it.

Some guides carry a button that takes you straight to the screen the task happens on.

Search

The box at the top left searches guides and the wiki at once, from anywhere in the panel, including from inside a guide. Clearing it puts you back where you were.

The screen switcher

Screens lists every screen that has help, so you can read about one screen while standing on another. Screens with sub-screens fold; the one you are actually on is marked This screen.

Asking a person

At the bottom of the navigation, under Missing something?, are the two places to ask a person: Tell us on GitHub opens a discussion, Ask on Discord opens the chat. They are there on every screen.

The pictures

Every picture is generated by driving the real app: same viewport, same theme, same language, same demo trip, on every screen. Nothing is drawn, cropped or retouched by hand, and a picture only exists if the steps it shows still work. When a button moves or a label changes, the run that makes the pictures fails, which is how the guides stay honest.

The pictures ship with your install as WebP and are loaded only when you open the panel, so they cost nothing to a visitor who never asks for help.

Languages

The guides are written in English first and translated into all 27 languages TREK speaks (see Languages). Every button and field a guide names is the app's own string in that language, so what you read matches what you see.

When a screen has no help yet

The panel says No guide for this screen yet. and leaves the search box as the way forward, with the Tell us on GitHub and Ask on Discord links below the navigation.

4.4 KiB Raw Permalink Blame History