Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/en-US/platform/dashboard/get-started.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -40,8 +40,8 @@ The Dashboard is the web app for reviewing translations, guiding the AI with con
The Dashboard is organized into nested scopes: **Enterprise**, **Organization**, and **Project**. Most teams use Organizations and Projects. Enterprise is a layer for larger teams managing multiple Organizations.

- **Enterprise** contains Organizations, members, billing, and security settings across multiple Organizations.
- **Organization** contains Projects, shared context, usage, Connections for authorized external services, and **Locadex > Automations** and **Locadex > Integrations**. **Developer** contains API keys and webhooks. **Settings** contains members, billing, plans, and Organization settings.
- **Project** contains translations, Project context, API keys, settings, **Automations**, and **Integrations > Connected** and **Integrations > Catalog**.
- **Organization** contains **Projects**, **Context**, **Connections**, **Usage**, **Locadex > Automations**, and **Locadex > Integrations**. **Developer** contains **API Keys**, **Webhooks**, and **Webhook Events**. **Settings** contains **General**, **Members**, **Access**, **SSO**, **Billing**, **Plans**, and **Audit Logs**.
- **Project** contains **Overview**, **Translations**, **Context**, **API Keys**, **Settings**, **Automations**, **Integrations > Connected**, and **Integrations > Catalog**.

Use the switcher in the header to move between scopes. The sidebar changes based on the selected scope.

Expand Down
4 changes: 2 additions & 2 deletions docs/en-US/platform/dashboard/guides/managing-billing.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ related:

---

Usage records and spend estimates live on **Organization > Usage**. Plans, credit balances, reload settings, and invoices live on **Organization > Settings > Billing**.
Usage records and spend estimates live on **Organization > Usage**. Compare plans under **Organization > Settings > Plans**. Credit balances, reload settings, and invoices live on **Organization > Settings > Billing**.

## Plans [#plans]

Expand Down Expand Up @@ -83,7 +83,7 @@ The billing contact receives email alerts before usage pauses:
- **Auto-reload off:** a balance warning after 80% of the loaded credit balance is used, followed by a depleted-balance alert at $0.
- **Auto-reload on with a Usage Limit:** a warning at 80% of the limit, followed by a limit-reached alert at 100%.

Balance alerts link to **Billing**, where you can buy credits or turn on auto-reload. Usage Limit alerts show the cap and billing-period reset date, and link to the setting so you can raise or remove it.
Balance alerts link to **Organization > Settings > Billing**, where you can buy credits or turn on auto-reload. Usage Limit alerts show the cap and billing-period reset date, and link to the setting so you can raise or remove it.

### When your balance runs out [#running-out]

Expand Down
2 changes: 1 addition & 1 deletion docs/en-US/platform/dashboard/reference/api-keys.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---

title: API keys
description: Create and manage Project and Organization API keys for apps, local development, and automation.
description: Create and manage Project and Organization API keys for apps, local development, and automation. Reference for API keys.

---

Expand Down
2 changes: 1 addition & 1 deletion docs/en-US/platform/dashboard/reference/webhooks.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---

title: Webhooks
description: Configure webhook endpoints, verify signatures, and handle translation events from General Translation.
description: Configure webhook endpoints, verify signatures, and handle translation events from General Translation. Reference for webhooks.

---

Expand Down
21 changes: 12 additions & 9 deletions docs/en-US/platform/openapi/openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -476,7 +476,10 @@ paths:
tags: [Files]
summary: Download a single file
deprecated: true
description: Download a single source or translated file. Prefer the batch POST endpoint.
description: >
Download a single source or translated file. This deprecated endpoint
is retained for backward compatibility; new integrations should use
`POST /v2/project/files/download`.
operationId: downloadFile
parameters:
- $ref: '#/components/parameters/GtApiVersion'
Expand Down Expand Up @@ -713,9 +716,9 @@ paths:
/v2/projects:
post:
tags: [Project]
summary: Create a project
summary: Create a Project
description: >
Create a project in the organization associated with an organization API
Create a Project in the Organization associated with an Organization API
key. The key must have the `org:projects:create` permission. Project keys
cannot use this endpoint. Enabling CDN delivery also requires
`project:write`.
Expand Down Expand Up @@ -796,10 +799,10 @@ paths:
/v2/project/assets:
post:
tags: [Project]
summary: Upload project assets
summary: Upload Project assets
description: >
Upload OpenType or TrueType fonts through a project and make them
available to Lottie translation workflows across its organization.
Upload OpenType or TrueType fonts through a Project and make them
available to Lottie translation workflows across its Organization.
Each font is keyed by a normalized identity derived from its family,
weight, and italic style (from the supplied `family` and `style`, or
from the font metadata and file name). Re-uploading the same identity
Expand Down Expand Up @@ -919,7 +922,7 @@ paths:
/v2/project/info/{projectId}:
get:
tags: [Project]
summary: Get project information
summary: Get Project information
description: >
Read the authenticated Project's name, Organization ID, locale settings,
and auto-approval setting.
Expand Down Expand Up @@ -953,8 +956,8 @@ paths:
'404': { $ref: '#/components/responses/NotFound' }
post:
tags: [Project]
summary: Update project information
description: Update the project's default locale or CDN delivery setting.
summary: Update Project information
description: Update the Project's default locale or CDN delivery setting.
operationId: updateProjectInfo
parameters:
- $ref: '#/components/parameters/GtApiVersion'
Expand Down
9 changes: 5 additions & 4 deletions docs/en-US/platform/openapi/reference/files/download.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---

title: "Download a single file"
description: "Download a single source or translated file. Prefer the batch POST endpoint. API reference for Download a single file."
description: "Download a single source or translated file. This deprecated endpoint is retained for backward compatibility; new integrations should use POST /v2/project/files/download. API reference for Download a single file."
method: GET
full: true
_openapi:
Expand All @@ -11,9 +11,10 @@ _openapi:
structuredData:
headings: []
contents:
- content: >-
Download a single source or translated file. Prefer the batch POST
endpoint.
- content: >
Download a single source or translated file. This deprecated endpoint
is retained for backward compatibility; new integrations should use
`POST /v2/project/files/download`.
---

{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---

title: "Create a project"
description: "Create a project in the organization associated with an organization API key. The key must have the org:projects:create permission. Project keys cannot use this endpoint. Enabling CDN delivery also requires project:write. API reference for Create a project."
title: "Create a Project"
description: "Create a Project in the Organization associated with an Organization API key. The key must have the org:projects:create permission. Project keys cannot use this endpoint. Enabling CDN delivery also requires project:write. API reference for Create a Project."
method: POST
full: true
_openapi:
Expand All @@ -12,7 +12,7 @@ _openapi:
headings: []
contents:
- content: >
Create a project in the organization associated with an organization
Create a Project in the Organization associated with an Organization
API key. The key must have the `org:projects:create` permission.
Project keys cannot use this endpoint. Enabling CDN delivery also
requires `project:write`.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---

title: "Get project information"
description: "Read the authenticated Project's name, Organization ID, locale settings, and auto-approval setting. API reference for Get project information."
title: "Get Project information"
description: "Read the authenticated Project's name, Organization ID, locale settings, and auto-approval setting. API reference for Get Project information."
method: GET
full: true
_openapi:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---

title: "Update project information"
description: "Update the project's default locale or CDN delivery setting. API reference for Update project information."
title: "Update Project information"
description: "Update the Project's default locale or CDN delivery setting. API reference for Update Project information."
method: POST
full: true
_openapi:
Expand All @@ -11,7 +11,7 @@ _openapi:
structuredData:
headings: []
contents:
- content: Update the project's default locale or CDN delivery setting.
- content: Update the Project's default locale or CDN delivery setting.
---

{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---

title: "Upload project assets"
description: "Upload OpenType or TrueType fonts through a project and make them available to Lottie translation workflows across its organization. Each font is keyed by a normalized identity derived from its family, weight, and italic style (from the supplied family and style, or from the font metadata and file name). Re-uploading the same identity overwrites the existing asset, so complete retries after a 500 response are safe. API reference for Upload project assets."
title: "Upload Project assets"
description: "Upload OpenType or TrueType fonts through a Project and make them available to Lottie translation workflows across its Organization. Each font is keyed by a normalized identity derived from its family, weight, and italic style (from the supplied family and style, or from the font metadata and file name). Re-uploading the same identity overwrites the existing asset, so complete retries after a 500 response are safe. API reference for Upload Project assets."
method: POST
full: true
_openapi:
Expand All @@ -12,8 +12,8 @@ _openapi:
headings: []
contents:
- content: >
Upload OpenType or TrueType fonts through a project and make them
available to Lottie translation workflows across its organization.
Upload OpenType or TrueType fonts through a Project and make them
available to Lottie translation workflows across its Organization.
Each font is keyed by a normalized identity derived from its family,
weight, and italic style (from the supplied `family` and `style`, or
from the font metadata and file name). Re-uploading the same identity
Expand Down
Loading