Overview — what it does
This manual is search-first. Instead of scanning menus, type what you want and jump straight to the relevant article and paragraph.
Opening search
Use any of three ways:
- Click the search box in the top-left
- Press
⌘K(macOS) orCtrl-K(Windows/Linux) - Press
/when you are not typing in a field
Search indexes the title, summary, tags, sub-headings and full body of every article. Even if you do not remember a screen's name, you can find it by concept words like "buffer pool", "cron" or "block".
How to search
- Open the palette and type. Results appear live, grouped by sector.
- Move with
↑↓and open with↵(Enter). Mouse clicks work too. - Selecting jumps to the article (or the exact sub-heading) and highlights your terms in the body.
- Close with
Esc.
Ranking
With multiple words, only articles where every word matches survive (AND). Score is set by where the match lands.
| Match location | Weight |
|---|---|
| Title/tag prefix | 100 |
| Title/tag substring | 70 |
| Sub-heading | 55 |
| Summary | 40 |
| Body | 20 |
Deep links
Every article and heading has its own address. Copy #article-key or #article-key/heading from the URL bar and share it — your teammate opens exactly the same spot. Browser back/forward work too.
Access
This manual is visible to every signed-in user. Articles about features you cannot use yet still open; a lock badge next to the title just shows the level required (→ Access levels).
Related
