tkhq · meowllark · Feb 25, 2025 · Mar 18, 2025 · Mar 18, 2025 · Mar 19, 2025
diff --git a/Dockerfile b/Dockerfile
diff --git a/Makefile b/Makefile
diff --git a/README.md b/README.md
@@ -2,13 +2,56 @@
 
 This repo hosts the documentation hosted at https://docs.turnkey.com.
 
-It's built with [Docusaurus](https://docusaurus.io/).
+## Development
+
+### Prerequisites
+
+To work with this documentation locally, you'll need:
+
+- Node.js (see `.nvmrc` for the recommended version)
+- npm or yarn
+
+### Local Development
+
+Install the [Mintlify CLI](https://www.npmjs.com/package/mintlify) to preview documentation changes locally:
+
+```sh
+# Install Mintlify CLI globally
+npm i -g mintlify
+
+# Start the local development server
+mintlify dev
+```
+
+This will start a local development server where you can preview your changes in real-time.
+
+If you encounter any issues with the development server:
 
-## Algolia
+- Run `mintlify install` to reinstall dependencies
+- Ensure you're running the command in a folder with `docs.json` (Mintlify's configuration file)
+
+> **Important:** If you previously worked with the Docusaurus version of this site, make sure to delete the `build` and `.docusaurus` folders before running the Mintlify docs site locally. Otherwise, you may experience style conflicts.
+
+### Deployment
+
+Changes to the documentation are automatically deployed when merged to the main branch through our CI/CD pipeline.
+
+### Mintlify Dashboard
+
+You can access the Mintlify dashboard for this project at:
+[dashboard.mintlify.com](https://dashboard.mintlify.com/turnkey-0e7c1f5b/turnkey-0e7c1f5b)
+
+## The dashboard provides analytics, deployment status, and other management features for our documentation.
+
+## Legacy Documentation
+
+The following information pertains to the previous Docusaurus-based documentation setup.
+
+### Algolia
 
 We use the Algolia plugin for Docusaurus to manage search on our docs page. The primary dashboard can be accessed via https://dashboard.algolia.com/apps/89KSB43UFT/dashboard. Reach out to Jack, Arnaud, or Andrew for access.
 
-### Crawling
+#### Crawling
 
 Our crawler settings can be found at https://crawler.algolia.com/admin/crawlers/15584ae7-61de-4f26-af35-4bc55d0de0b5/overview. Algolia crawls our docs site once a week on Monday at 12:31 (UTC). This is simply the default behavior. There are cases where we may want to forcefully trigger Algolia to crawl/index our site, i.e. when we do a big refactor or otherwise reorganize the structure of our docs significantly.
 
@@ -18,8 +61,6 @@ In order to manually trigger a new crawl, use the `Restart crawling` button:
 
 Our docs site is small, so each crawl is quick (~30-60s).
 
-## Development
-
 ### Vercel
 
 Each push to Github will trigger a Vercel build:
@@ -28,7 +69,7 @@ Each push to Github will trigger a Vercel build:
 
 This is a convenient way to view changes, add feedback, and collaborate overall. Any build can also be promoted to production, if need be.
 
-### Local Development
+### Legacy Local Development
 
 #### With yarn
 

diff --git a/api-overview.mdx b/api-overview.mdx
@@ -0,0 +1,27 @@
+---
+title: API Overview
+mode: wide
+sidebarTitle: Overview
+---
+
+<CardGroup>
+  <Card title="Introduction" href="/developer-reference/api-overview/intro" icon="file-lines" iconType="solid" horizontal>
+    Getting started with the Turnkey API
+  </Card>
+
+  <Card title="Stamps" href="/developer-reference/api-overview/stamps" icon="file-lines" iconType="solid" horizontal>
+    Creating your first signed request
+  </Card>
+
+  <Card title="Queries" href="/developer-reference/api-overview/queries" icon="file-lines" iconType="solid" horizontal>
+    Fetching data from Turnkey
+  </Card>
+
+  <Card title="Submissions" href="/developer-reference/api-overview/submissions" icon="file-lines" iconType="solid" horizontal>
+    Secure execution with Turnkey
+  </Card>
+
+  <Card title="Errors" href="/developer-reference/api-overview/errors" icon="file-lines" iconType="solid" horizontal>
+    Enumerating all errors received using the Turnkey API
+  </Card>
+</CardGroup>
diff --git a/api-reference/activities/get-activity.mdx b/api-reference/activities/get-activity.mdx
@@ -0,0 +1,3 @@
+---
+openapi: post /public/v1/query/get_activity
+---
diff --git a/api-reference/activities/list-activities.mdx b/api-reference/activities/list-activities.mdx
@@ -0,0 +1,3 @@
+---
+openapi: post /public/v1/query/list_activities
+---
diff --git a/api-reference/activities/overview.mdx b/api-reference/activities/overview.mdx
@@ -0,0 +1,7 @@
+---
+title: "Activities"
+description: "Activities encapsulate all the possible actions that can be taken with Turnkey. Some examples include adding a new user, creating a private key, and signing a transaction."
+sidebarTitle: "Overview"
+mode: wide
+---
+Activities that modify your Organization are processed asynchronously. To confirm processing is complete and retrieve the Activity results, these activities must be polled until that status has been updated to a finalized state: `COMPLETED` when the activity is successful or `FAILED` when the activity has failed
diff --git a/api-reference/api-keys/create-api-keys.mdx b/api-reference/api-keys/create-api-keys.mdx
@@ -0,0 +1,3 @@
+---
+openapi: post /public/v1/submit/create_api_keys
+---
diff --git a/api-reference/api-keys/delete-api-keys.mdx b/api-reference/api-keys/delete-api-keys.mdx
@@ -0,0 +1,3 @@
+---
+openapi: post /public/v1/submit/delete_api_keys
+---
diff --git a/api-reference/api-keys/get-api-key-1.mdx b/api-reference/api-keys/get-api-key-1.mdx
@@ -0,0 +1,3 @@
+---
+openapi: post /public/v1/query/get_api_keys
+---
diff --git a/api-reference/api-keys/get-api-key.mdx b/api-reference/api-keys/get-api-key.mdx
@@ -0,0 +1,3 @@
+---
+openapi: post /public/v1/query/get_api_key
+---
diff --git a/api-reference/api-keys/overview.mdx b/api-reference/api-keys/overview.mdx
@@ -0,0 +1,7 @@
+---
+title: "API Keys"
+description: "API Keys are used to authenticate requests"
+sidebarTitle: "Overview"
+mode: wide
+---
+See our [CLI](https://github.com/tkhq/tkcli) for instructions on generating API Keys
diff --git a/api-reference/authenticators/create-authenticators.mdx b/api-reference/authenticators/create-authenticators.mdx
@@ -0,0 +1,3 @@
+---
+openapi: post /public/v1/submit/create_authenticators
+---
diff --git a/api-reference/authenticators/delete-authenticators.mdx b/api-reference/authenticators/delete-authenticators.mdx
@@ -0,0 +1,3 @@
+---
+openapi: post /public/v1/submit/delete_authenticators
+---
diff --git a/api-reference/authenticators/get-authenticator.mdx b/api-reference/authenticators/get-authenticator.mdx
@@ -0,0 +1,3 @@
+---
+openapi: post /public/v1/query/get_authenticator
+---
diff --git a/api-reference/authenticators/get-authenticators.mdx b/api-reference/authenticators/get-authenticators.mdx
@@ -0,0 +1,3 @@
+---
+openapi: post /public/v1/query/get_authenticators
+---
diff --git a/api-reference/authenticators/overview.mdx b/api-reference/authenticators/overview.mdx
@@ -0,0 +1,6 @@
+---
+title: "Authenticators"
+description: "Authenticators are WebAuthN hardware devices, such as a Macbook TouchID or Yubikey, that can be used to authenticate requests."
+sidebarTitle: "Overview"
+mode: wide
+---
diff --git a/api-reference/consensus/approve-activity.mdx b/api-reference/consensus/approve-activity.mdx
@@ -0,0 +1,3 @@
+---
+openapi: post /public/v1/submit/approve_activity
+---
diff --git a/api-reference/consensus/overview.mdx b/api-reference/consensus/overview.mdx
@@ -0,0 +1,8 @@
+---
+title: "Consensus"
+description: "Policies can enforce consensus requirements for Activities. For example, adding a new user requires two admins to approve the request."
+sidebarTitle: "Overview"
+mode: wide
+---
+
+Activities that have been proposed, but don't yet meet the Consesnsus requirements will have the status: `REQUIRES_CONSENSUS`. Activities in this state can be approved or rejected using the unique fingerprint generated when an Activity is created.
diff --git a/api-reference/consensus/reject-activity.mdx b/api-reference/consensus/reject-activity.mdx
@@ -0,0 +1,3 @@
+---
+openapi: post /public/v1/submit/reject_activity
+---
diff --git a/api-reference/features/remove-organization-feature.mdx b/api-reference/features/remove-organization-feature.mdx
@@ -0,0 +1,3 @@
+---
+openapi: post /public/v1/submit/remove_organization_feature
+---
diff --git a/api-reference/features/set-organization-feature.mdx b/api-reference/features/set-organization-feature.mdx
@@ -0,0 +1,3 @@
+---
+openapi: post /public/v1/submit/set_organization_feature
+---
diff --git a/api-reference/invitations/create-invitations.mdx b/api-reference/invitations/create-invitations.mdx
@@ -0,0 +1,3 @@
+---
+openapi: post /public/v1/submit/create_invitations
+---
diff --git a/api-reference/invitations/delete-invitation.mdx b/api-reference/invitations/delete-invitation.mdx
@@ -0,0 +1,3 @@
+---
+openapi: post /public/v1/submit/delete_invitation
+---
diff --git a/api-reference/invitations/overview.mdx b/api-reference/invitations/overview.mdx
@@ -0,0 +1,8 @@
+---
+title: "Invitations"
+description: "Invitations allow you to invite Users into your Organization via email. Alternatively, Users can be added directly without an Invitation if their ApiKey or Authenticator credentials are known ahead of time."
+sidebarTitle: "Overview"
+mode: wide
+---
+
+See [Users](/api-reference/users/overview) for more information
diff --git a/api-reference/organizations/create-sub-organization.mdx b/api-reference/organizations/create-sub-organization.mdx
@@ -0,0 +1,3 @@
+---
+openapi: post /public/v1/submit/create_sub_organization
+---
diff --git a/api-reference/organizations/delete-sub-organization.mdx b/api-reference/organizations/delete-sub-organization.mdx
@@ -0,0 +1,3 @@
+---
+openapi: post /public/v1/submit/delete_sub_organization
+---
diff --git a/api-reference/organizations/get-configs.mdx b/api-reference/organizations/get-configs.mdx
@@ -0,0 +1,3 @@
+---
+openapi: post /public/v1/query/get_organization_configs
+---
diff --git a/api-reference/organizations/get-suborgs.mdx b/api-reference/organizations/get-suborgs.mdx
@@ -0,0 +1,3 @@
+---
+openapi: post /public/v1/query/list_suborgs
+---
diff --git a/api-reference/organizations/get-verified-suborgs.mdx b/api-reference/organizations/get-verified-suborgs.mdx
@@ -0,0 +1,3 @@
+---
+openapi: post /public/v1/query/list_verified_suborgs
+---
diff --git a/api-reference/organizations/overview.mdx b/api-reference/organizations/overview.mdx
@@ -0,0 +1,8 @@
+---
+title: "Organizations"
+description: "An Organization is the highest level of hierarchy in Turnkey. It can contain many Users, Private Keys, and Policies managed by a Root Quorum. The Root Quorum consists of a set of Users with a consensus threshold. This consensus threshold must be reached by Quorum members in order for any actions to take place."
+sidebarTitle: "Overview"
+mode: wide
+---
+
+See [Root Quorum](/concepts/users/root-quorum) for more information
diff --git a/api-reference/organizations/update-root-quorum.mdx b/api-reference/organizations/update-root-quorum.mdx
@@ -0,0 +1,3 @@
+---
+openapi: post /public/v1/submit/update_root_quorum
+---
diff --git a/api-reference/overview.mdx b/api-reference/overview.mdx
@@ -0,0 +1,7 @@
+---
+title: "API Reference"
+description: "Review our [API Introduction](/developer-reference/api-overview/intro) to get started."
+sidebarTitle: "Overview"
+mode: wide
+---
+
diff --git a/api-reference/policies/create-policies.mdx b/api-reference/policies/create-policies.mdx
@@ -0,0 +1,3 @@
+---
+openapi: post /public/v1/submit/create_policies
+---
diff --git a/api-reference/policies/create-policy.mdx b/api-reference/policies/create-policy.mdx
@@ -0,0 +1,3 @@
+---
+openapi: post /public/v1/submit/create_policy
+---
diff --git a/api-reference/policies/delete-policy.mdx b/api-reference/policies/delete-policy.mdx
@@ -0,0 +1,3 @@
+---
+openapi: post /public/v1/submit/delete_policy
+---
diff --git a/api-reference/policies/get-policy.mdx b/api-reference/policies/get-policy.mdx
@@ -0,0 +1,3 @@
+---
+openapi: post /public/v1/query/get_policy
+---
diff --git a/api-reference/policies/list-policies.mdx b/api-reference/policies/list-policies.mdx
@@ -0,0 +1,3 @@
+---
+openapi: post /public/v1/query/list_policies
+---
diff --git a/api-reference/policies/overview.mdx b/api-reference/policies/overview.mdx
@@ -0,0 +1,7 @@
+---
+title: "Policies"
+description: "Policies allow for deep customization of the security of your Organization. They can be used to grant permissions or restrict usage of Users and Private Keys. The Policy Engine analyzes all of your Policies on each request to determine whether an Activity is allowed."
+sidebarTitle: "Overview"
+mode: wide
+---
+See [Policy Overview](/concepts/policies/overview) for more information
diff --git a/api-reference/policies/update-policy.mdx b/api-reference/policies/update-policy.mdx
@@ -0,0 +1,3 @@
+---
+openapi: post /public/v1/submit/update_policy
+---
diff --git a/api-reference/private-key-tags/create-private-key-tag.mdx b/api-reference/private-key-tags/create-private-key-tag.mdx
@@ -0,0 +1,3 @@
+---
+openapi: post /public/v1/submit/create_private_key_tag
+---
diff --git a/api-reference/private-key-tags/delete-private-key-tags.mdx b/api-reference/private-key-tags/delete-private-key-tags.mdx
@@ -0,0 +1,3 @@
+---
+openapi: post /public/v1/submit/delete_private_key_tags
+---