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

# Getting started with Timekettle Developer

> Understand the Timekettle Developer documentation structure, integration assumptions, and production readiness steps.

# Getting started with Timekettle Developer

Use this guide as the starting point for Timekettle integrations and documentation maintenance. The current site focuses on developer onboarding and required legal pages for a production-ready launch at `https://developer.timekettle.co`.

<Info>
  Run Mintlify commands from the `docs/` directory because `docs/docs.json` is the project configuration file.
</Info>

## Project layout

```text theme={null}
docs/
├── docs.json
├── index.mdx
├── getting-started/
│   └── overview.mdx
├── legal/
│   ├── privacy-policy.mdx
│   ├── terms-of-service.mdx
│   └── cookie-policy.mdx
└── assets/
```

## Local development

<Steps>
  <Step title="Install or update the Mintlify CLI">
    ```bash theme={null}
    npm i -g mint
    ```
  </Step>

  <Step title="Start the development server">
    ```bash theme={null}
    cd docs
    mint dev
    ```
  </Step>

  <Step title="Validate content before deployment">
    ```bash theme={null}
    mint validate
    mint broken-links
    ```
  </Step>
</Steps>

## Integration assumptions

<Tabs sync={false}>
  <Tab title="SDK teams" icon="package">
    Treat the legal pages as the public documentation layer for SDK data handling. When SDK behavior changes, update [Privacy Policy](/legal/privacy-policy) and verify that developer-facing disclosures still match the implementation.
  </Tab>

  <Tab title="API teams" icon="braces">
    Add future API references as separate pages or generated OpenAPI content. Keep authentication, rate limits, error handling, and data retention behavior explicit.
  </Tab>

  <Tab title="Product teams" icon="layers">
    Keep product claims out of legal pages unless they are reviewed and stable. Use the home page and getting started guide for developer positioning and onboarding.
  </Tab>
</Tabs>

## Production readiness checklist

<AccordionGroup>
  <Accordion title="Before connecting the custom domain" icon="globe">
    Confirm that `developer.timekettle.co` is configured in the Mintlify dashboard and that DNS records point to the deployment target supplied by Mintlify.
  </Accordion>

  <Accordion title="Before publishing legal pages" icon="scale">
    Ask legal counsel to review jurisdiction, governing law, contact details, retention periods, subprocessors, and data transfer language.
  </Accordion>

  <Accordion title="Before adding API references" icon="server">
    Decide whether the source of truth is OpenAPI, handwritten MDX, or a hybrid. Prefer generated OpenAPI pages when the API contract is stable.
  </Accordion>

  <Accordion title="Before release" icon="check-circle">
    Run `mint validate`, `mint broken-links`, and a local `mint dev` preview. Check navigation, search labels, dark mode, and footer links.
  </Accordion>
</AccordionGroup>

## Maintenance guidelines

* Add every public page to `docs.json` navigation.
* Use root-relative internal links, such as `/legal/privacy-policy`.
* Keep navigation depth at three levels or fewer.
* Use MDX components for summaries, choices, and progressive disclosure.
* Update the `Last Updated` date when a policy changes materially.
* Keep the GitHub link in `docs.json` pointed at the final documentation repository before launch.
