> ## Documentation Index
> Fetch the complete documentation index at: https://docs.nyumbazetu.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Navigating the app

> Branches, the sidebar, grids, filters, views, and the controls that appear on every screen.

Nyumba Zetu reuses the same handful of interface patterns everywhere. Learn them once and every
module behaves predictably.

## Branch context

The top of the sidebar is named after the **branch** you are currently working in. Branch scoping
is not a filter you can ignore — lists, KPIs, reports and totals are all computed for the active
branch.

<Warning>
  Switch branch **before** you start a task. If a lease, invoice or payment "disappears", the first
  thing to check is whether you are in the branch that owns it.
</Warning>

## Sidebar structure

The sidebar is grouped by how work flows, not by database tables:

1. **Workspace** (named after your branch) — Home, Organization, Leases, Residents, Owners.
2. **Finance** — Receivables, Payables, Collections, Accounting, TPS, Reports.
3. **Operations** — Communications, Operations, CRM, Admin.
4. **Super Admin** — cross-organisation tooling, visible only to platform administrators.

Groups with children expand in place. Items marked **Beta** are live but still evolving; items
marked **New** were added recently.

## Page chrome

Most detail and list pages share the same furniture:

* **Breadcrumb** — the path back up the hierarchy. Detail pages are addressed by UUID, so the URL
  in your address bar is safe to copy and share with a colleague.
* **Page header** — title, description, and the primary action. Pages deliberately expose *one*
  primary action; everything else lives in the overflow menu. Disabled actions explain why on
  hover.
* **Tab strip** — where a module has genuinely distinct pages (for example Collections' *Overview
  · Worklist · Strategies*). Modules with a single page hide the strip.
* **Settings gear** — where a screen has configurable behaviour, a gear button opens the
  category-scoped settings panel for it instead of sending you to a global settings page.

## Working with grids

Most lists are AG-Grid tables with server-side paging.

| Control            | What it does                                                                                                                                                                  |
| ------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Column filters** | Per-column filtering (text, number, date, set). Blank / not-blank are supported on text and identifier columns.                                                               |
| **Quick filters**  | The chip bar above the grid. The primary dimension renders as a segmented control; the remaining dimensions collapse into dropdown pills. Chips are combinable and clearable. |
| **Sort & group**   | Click a header to sort; drag to the group bar to group. Numeric and currency columns aggregate with totals.                                                                   |
| **Column chooser** | Show, hide and reorder columns. Your layout persists per grid.                                                                                                                |
| **Export**         | Export the current view (respecting filters) to CSV or Excel.                                                                                                                 |
| **Row actions**    | The right-hand action cell opens the record, or exposes inline actions such as allocate, send, or approve.                                                                    |
| **Bulk actions**   | Select rows with the checkbox column to act on many records at once (send, approve, allocate, delete).                                                                        |

<Tip>
  Filters and quick-view chips are written into the URL. Bookmark a filtered grid — or paste the URL
  into a message — and it reopens exactly as you left it.
</Tip>

### View modes

Where a list has more than one useful shape, a **view switcher** appears in the title bar:

* **Grid** — the table.
* **Kanban** — cards grouped by status, for workflow-shaped data such as applications or service
  requests.
* **Calendar** — date-shaped data such as lease starts and ends, reservations, or scheduled tasks.
  A row can plot more than one event (a lease shows both its start and end chip), with a legend
  above the calendar.

### Detail drawers

Clicking a row can open an off-canvas **drawer** with the record summary and its actions, without
losing your place in the list. Drawers support the same actions as the full detail page for the
common cases; open the full page when you need tabs, timelines or documents.

## Search

* **Global search** in the top bar finds records across modules by name, code or reference.
* **In-grid search** filters the current list only.
* **Ask Nyumba Zetu** (`/rag`, platform administrators) answers natural-language questions over
  your data.

## Notifications and messages

* The **bell** shows system notifications — approvals waiting on you, job outcomes, failures.
* **Mailbox** and **Chat** hold operator-to-operator and operator-to-resident conversations.
* **Delivery Tracker** shows the outcome of every SMS and email the platform sent on your behalf.

## Appearance

* **Dark mode** — toggle it from the user menu at the bottom of the sidebar. The choice is stored
  per browser, so it follows you between sessions on the same device.
* **Branding** — colours, logo and product name are set per organisation. Financial status colours
  (green paid, red arrears, orange due-soon, blue informational) are fixed for every tenant so
  numbers read the same way everywhere.
* **Density and responsiveness** — every screen works on a phone; wide tables scroll horizontally
  inside their own container rather than pushing the page sideways.

## Staying current

The app polls for new releases while you have it open and shows an **update banner** when a newer
version is available. Reload when you see it — long-lived tabs can otherwise hold stale code
against a newer API.

## Keyboard and productivity

* `Esc` closes drawers and dialogs.
* Grid navigation follows standard AG-Grid keys — arrows to move, `Enter` to open, `Space` to
  select.
* Most "add" flows accept `Ctrl/Cmd + Enter` to save.

## Next

<Columns cols={2}>
  <Card title="Roles & permissions" icon="lock" href="/getting-started/roles-and-permissions">
    Why you can see some screens and not others.
  </Card>

  <Card title="Glossary" icon="book-open" href="/getting-started/glossary">
    The vocabulary the product uses, defined precisely.
  </Card>
</Columns>
