docs: pipeline-generated pages (?, Languages, Voice) - #423
docs: pipeline-generated pages (?, Languages, Voice)#423github-actions[bot] wants to merge 1 commit into
Conversation
Generated 3 pages for: Languages, Voice, unknown - docs/voice/translate-an-audio-file-with-the-voice-translate-job-api.mdx: No guide (tutorial or how-to) covers the 'Translate Audio Files' endpoints - docs/languages/query-language-support-for-a-specific-resource.mdx: No guide (tutorial or how-to) covers the 'Languages' endpoints - docs/learning-how-tos/cookbook/google-sheets: docs/learning-how-tos/cookbook/google-sheets has under 100 words
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
|
|
||
| source_languages = [lang for lang in languages if lang["usable_as_source"]] | ||
| target_languages = [lang for lang in languages if lang["usable_as_target"]] | ||
|
|
There was a problem hiding this comment.
Step 4 response block missing request context
The JSON response block for GET /v3/languages/resources (lines ~115-129) is not preceded by a labeled 'Example response' heading or comment, making it easy to misread as a continuation of the curl request output. The two blocks (curl and JSON) are separated only by a blank line with no label.
Suggested fix: Add a short label between the curl block and the JSON block, e.g. 'The response lists each resource and its feature requirements:' to mirror the pattern used in Step 2.
| The `resource` parameter is required. If you're migrating from `/v2/languages`, see the [migration guide](/docs/languages/migrating-from-v2-languages) — the v3 response structure is different. | ||
| </Info> | ||
|
|
||
| ## Before you start |
There was a problem hiding this comment.
Info box placement slightly delays key migration context
The Info callout about the required resource parameter and v2 migration appears after the opening two paragraphs. Developers who are migrating are likely to miss it since they may skim past the intro. The style guide recommends front-loading key information.
Suggested fix: Move the Info box to immediately after the title/opening sentence, before the second paragraph that begins 'This guide shows you...' — or fold the migration note into the Before you start section as a brief sentence with the link.
|
|
||
| Call `GET /v3/languages` with your chosen `resource` value. This example queries languages for text translation: | ||
|
|
||
| ```sh |
There was a problem hiding this comment.
Table left-alignment not specified for status/symbol columns
The resource table uses default alignment (no explicit column alignment syntax). Per CLAUDE.md, text columns should be left-aligned. The table currently has no alignment row specified, which may render inconsistently depending on Mintlify defaults.
Suggested fix: Add explicit column alignment to the table: |:---|:---| on the separator row to left-align both columns.
| } | ||
| ] | ||
| ``` | ||
|
|
There was a problem hiding this comment.
BCP 47 link points to an internal docs path but uses a full URL pattern
The BCP 47 link (https://developers.deepl.com/docs/resources/language-release-process) uses an absolute URL to an internal page. Per CLAUDE.md, internal links should use relative paths.
Suggested fix: Replace the absolute URL with a relative path: [BCP 47](/docs/resources/language-release-process).
| { | ||
| "results": [ | ||
| { | ||
| "status": "complete", |
There was a problem hiding this comment.
Polling guidance mixes how-to and reference content
The paragraph 'Poll every 10-30 seconds for files under 100 MB...' introduces numeric thresholds (100 MB, 10-30 seconds, several minutes) that are reference-level constraints. Per the API reference conventions in CLAUDE.md, numeric limits belong on the reference page, not in guides. The guide should give actionable polling advice without encoding specific limits inline.
Suggested fix: Replace with: 'Poll every 10-30 seconds. For polling interval and file size guidance, see the Translate Audio Files reference. Keep polling until every result has reached a terminal status: complete, failed, or downloaded.' Remove the '100 MB' and 'several minutes' mentions.
| } | ||
| ``` | ||
|
|
||
| Results are returned in the same order as the `targets` array in your create request, so `results[0]` corresponds to `targets[0]`. |
There was a problem hiding this comment.
Inline time limit for download window is a numeric constraint
The sentence 'You have 1 hour from the time the upload completes to download all results' encodes a specific numeric limit inline in a how-to guide. Per CLAUDE.md conventions, numeric limits live on the reference/requirements page, not in guide prose.
| Results are returned in the same order as the `targets` array in your create request, so `results[0]` corresponds to `targets[0]`. | |
| Results are returned in the same order as the `targets` array in your create request, so `results[0]` corresponds to `targets[0]`. |
| { | ||
| "job_id": "a74d88fb-ed2a-4943-a664-a4512398b994", | ||
| "signature": "eyJhbGciOiJIUzI1NiIs...", | ||
| "upload_url": "https://assets.deepl.com/collections/a74d88fb-ed2a-4943-a664-a4512398b994/assets/b1c2d3e4-f5a6-7890-abcd-ef1234567890" |
There was a problem hiding this comment.
Upload expiry time limit inline in guide
The sentence 'You have 5 minutes to complete the upload before the URL expires' is a numeric limit that belongs on the reference page, not in the how-to guide.
| "upload_url": "https://assets.deepl.com/collections/a74d88fb-ed2a-4943-a664-a4512398b994/assets/b1c2d3e4-f5a6-7890-abcd-ef1234567890" | |
| "upload_url": "https://assets.deepl.com/collections/a74d88fb-ed2a-4943-a664-a4512398b994/assets/b1c2d3e4-f5a6-7890-abcd-ef1234567890" | |
| } |
Save the job_id for polling and the upload_url for the next step. Complete the upload before the URL expires — see the Translate Audio Files reference for the expiry window.
Summary
Generated documentation pages from the agentic docs pipeline (run
20260820-095624).Families: Languages, Voice, unknown
Model: claude-sonnet-4-6
Pages added/updated
docs/voice/translate-an-audio-file-with-the-voice-translate-job-api.mdx— missing_group_coveragedocs/languages/query-language-support-for-a-specific-resource.mdx— missing_group_coveragedocs/learning-how-tos/cookbook/google-sheets— expanded thin pageQuality checks
How to review
mint devto preview locallyGenerated by the agentic docs pipeline (
pipeline/generate.py)