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

# Canary product guide

> Set up Canary, run maintenance work, and keep equipment history connected.

Canary is a computerized maintenance management system for planning work, maintaining equipment, controlling parts, and finding operational knowledge across web and mobile.

Use this guide for step-by-step tasks, product concepts, and recovery guidance. Developers can use the [API documentation](/introduction) for external integrations.

## Start with your goal

<CardGroup cols={2}>
  <Card title="Set up Canary" icon="play" href="/help/getting-started/quickstart">
    Create the people, locations, assets, and standards your team needs first.
  </Card>

  <Card title="Manage work" icon="clipboard-list" href="/help/managing-work/overview">
    Turn requests and maintenance plans into assigned, completed work.
  </Card>

  <Card title="Manage equipment" icon="factory" href="/help/managing-equipment/overview">
    Build the asset, location, meter, document, and identifier model.
  </Card>

  <Card title="Control parts and purchasing" icon="package" href="/help/parts-purchasing/overview">
    Track stock, work-order demand, vendors, orders, and receipts.
  </Card>

  <Card title="Automate and understand" icon="sparkles" href="/help/automate-and-understand/overview">
    Respond to meter readings, use Ask Canary, and review reports.
  </Card>

  <Card title="Manage your organization" icon="settings" href="/help/manage-organization/overview">
    Configure users, teams, features, custom fields, and API keys.
  </Card>
</CardGroup>

## Choose a surface

| Surface              | Best for                                                              |
| -------------------- | --------------------------------------------------------------------- |
| Web app              | Setup, planning, purchasing, administration, and detailed analysis    |
| iOS and Android apps | Field work, requests, asset and part lookup, scanning, and Ask Canary |
| Public API v1        | Organization-scoped integrations using API keys and explicit scopes   |

## Build trustworthy history

Create locations and assets before linking meters, parts, procedures, and work. Record status changes, readings, stock movements, and work completion on the record where they occurred. Canary can then preserve a useful operational history when master records are archived.

## Need help?

* Start with [Troubleshooting](/help/troubleshooting/overview).
* Include the request ID when reporting an API problem.
* Contact [support@oncanary.com](mailto:support@oncanary.com) for account help.