Skip to main content

​
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.
Run Mintlify commands from the docs/ directory because docs/docs.json is the project configuration file.

​
Project layout

docs/
├── docs.json
├── index.mdx
├── getting-started/
│   └── overview.mdx
├── legal/
│   ├── privacy-policy.mdx
│   ├── terms-of-service.mdx
│   └── cookie-policy.mdx
└── assets/

​
Local development

1

Install or update the Mintlify CLI

npm i -g mint
2

Start the development server

cd docs
mint dev
3

Validate content before deployment

mint validate
mint broken-links

​
Integration assumptions

Treat the legal pages as the public documentation layer for SDK data handling. When SDK behavior changes, update Privacy Policy and verify that developer-facing disclosures still match the implementation.

​
Production readiness checklist

Confirm that developer.timekettle.co is configured in the Mintlify dashboard and that DNS records point to the deployment target supplied by Mintlify.
Decide whether the source of truth is OpenAPI, handwritten MDX, or a hybrid. Prefer generated OpenAPI pages when the API contract is stable.
Run mint validate, mint broken-links, and a local mint dev preview. Check navigation, search labels, dark mode, and footer links.

​
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.