Skip to content
Open
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
12 changes: 11 additions & 1 deletion apps/content/src/components/Video.tsx
Original file line number Diff line number Diff line change
@@ -1,10 +1,20 @@
export default function Video({ src }: { src: string }) {
export default function Video({
src,
muted = false,
}: {
src: string;
// Unused: MDX parity with the landing renderer; theming is disabled here,
// so only the light source is ever rendered.
srcDark?: string;
muted?: boolean;
}) {
return (
<video
src={src}
loop
controls
autoPlay
muted={muted}
playsInline
style={{ width: '100%', height: 'auto', borderRadius: 6 }}
/>
Expand Down
1 change: 1 addition & 0 deletions apps/content/src/mdx-components.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@ const customComponents = {
CardHeader: StubComponent,
CardTitle: StubComponent,
SupportedLocales: StubComponent,
Asciinema: StubComponent,
Video,
} satisfies MDXComponents;

Expand Down
4 changes: 4 additions & 0 deletions docs/en-US/cli/quickstart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,10 @@ The General Translation CLI (`gt`) sets up internationalization and translates y

It works with [`gt-react`, `gt-next`, and `gt-react-native`](/docs/react/overview), with third-party i18n libraries like `next-intl` and `i18next`, and with standalone files such as JSON, YAML, Markdown, and MDX.

Watch a full setup below, from install to first translation, then follow the same steps in your own project.

<Asciinema src="/remote-assets/walkthroughs/cli-quickstart.cast" cols={100} rows={28} />

## What the CLI does [#what-it-does]

The CLI gives you direct access to:
Expand Down
2 changes: 2 additions & 0 deletions docs/en-US/platform/dashboard/get-started.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@ related:

The Dashboard is the web app for reviewing translations, guiding the AI with context and glossaries, and managing settings and API keys.

<Video muted src="https://assets.gtx.dev/walkthroughs/platform-dashboard-get-started-light.mp4" srcDark="https://assets.gtx.dev/walkthroughs/platform-dashboard-get-started-dark.mp4" />

## Key workflows [#key-workflows]

- **Define context and key terms for translation:** use Context Groups to guide terminology and style across Projects. See [Define translation context](/docs/platform/dashboard/guides/adding-translation-context).
Expand Down
3 changes: 3 additions & 0 deletions docs/en-US/platform/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,9 @@ description: Browse docs for the General Translation Platform, including the Das
These sections cover the Dashboard, the core `generaltranslation` library, Locadex, and the HTTP API.

<Cards>
<Card title="Quickstart" href="/docs/platform/quickstart">
Set up General Translation in the Dashboard, from a new account to your first translation.
</Card>
<Card title="Dashboard" href="/docs/platform/dashboard/get-started">
Learn how the Dashboard is organized and where to find common translation workflows.
</Card>
Expand Down
2 changes: 1 addition & 1 deletion docs/en-US/platform/meta.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,5 @@
"icon": "GT",
"root": true,
"description": "Dashboard, Agents, APIs",
"pages": ["./index", "./dashboard", "./locadex", "./core", "./openapi"]
"pages": ["./index", "./quickstart", "./dashboard", "./locadex", "./core", "./openapi"]
}
58 changes: 58 additions & 0 deletions docs/en-US/platform/quickstart.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
---

title: Quickstart
description: Set up General Translation in the Dashboard. Create an Organization and Project, get an API key, and run your first translation.
related:
links:
- /docs/platform/dashboard/get-started
- /docs/platform/dashboard/reference/api-keys
- /docs/platform/dashboard/guides/reviewing-translations
- /docs/cli/quickstart

---

The Dashboard is where you set up General Translation, store translations, and guide the AI. This guide takes you from a new account to your first translation.

You will create an Organization and a Project, get an API key, run one translation, and see it in the Dashboard.

<Video muted src="https://assets.gtx.dev/walkthroughs/platform-quickstart-light.mp4" srcDark="https://assets.gtx.dev/walkthroughs/platform-quickstart-dark.mp4" />

## Quickstart [#quickstart]
Sign up, create a Project, get an API key, and translate your first content.

### 1. Create your account

Sign up at [dash.generaltranslation.com](https://dash.generaltranslation.com/signup). Your account starts in an Organization, which holds your Projects, team members, and shared context.

For how the Dashboard is organized into Enterprise, Organization, and Project scopes, see [Get started with the Dashboard](/docs/platform/dashboard/get-started).

### 2. Create a Project

From your Organization, create a Project and set its source locale. A Project holds the translations, context, and API keys for one app, site, or content source.

Open **Project settings** to find your Project ID. You need it, along with an API key, to translate. See [Project settings](/docs/platform/dashboard/reference/project-settings) for the rest of the fields.

### 3. Get an API key

Open **Project > API Keys** and create a Project key. Copy the full key right away and store it in an environment variable. Production keys start with `gtx-api-` and development keys start with `gtx-dev-`. See [API keys](/docs/platform/dashboard/reference/api-keys) for scopes and when to use each one.

```bash title=".env.local"
GT_API_KEY=your-api-key
GT_PROJECT_ID=your-project-id
```

*Note: Keep your API key in an environment variable or a secrets manager. Never commit it to source control.*

### 4. Run your first translation

Point a tool at your Project with those credentials and translate. The fastest path is the [`gt` CLI](/docs/cli/quickstart): run `npx gt init` to set up a config, then `npx gt translate`. You can also use the [Core library](/docs/platform/core/quickstart) or one of the [framework libraries](/docs/react/overview).

### 5. See your translations

Open your Project's **Translations** page to view the results. From there you can compare locales, edit translations by hand, and add context to guide future output. See [Reviewing and editing translations](/docs/platform/dashboard/guides/reviewing-translations).

## Next steps [#next-steps]

- Guide the AI with glossaries and directives. See [Define translation context](/docs/platform/dashboard/guides/adding-translation-context).
- Automate translation on every pull request with [Locadex](/docs/platform/locadex/quickstart).
- Run translations in CI with the [CLI](/docs/cli/quickstart#ci-setup).
Loading