Skip to content

docs: retire translate overview, create how-to page#390

Open
shirgoldbird wants to merge 3 commits into
mainfrom
docs/pipeline-20260707-215756-retire-translate-overview
Open

docs: retire translate overview, create how-to page#390
shirgoldbird wants to merge 3 commits into
mainfrom
docs/pipeline-20260707-215756-retire-translate-overview

Conversation

@shirgoldbird

Copy link
Copy Markdown
Member

Summary

  • Retires api-reference/translate.mdx (537-line narrative overview)
  • Creates docs/learning-how-tos/examples-and-guides/translating-text.mdx — a how-to page with the unique content (model_type guidance, batching strategies, sentence splitting, in-text markup, code examples in 7 languages)
  • Endpoint page (api-reference/translate/request-translation.mdx) stays as a clean OpenAPI stub
  • Parameter descriptions discarded (covered by OpenAPI spec auto-rendering)

Generated by the agentic docs pipeline (rework → evaluate → review → promote).

Test plan

  • Preview with mint dev — verify the new how-to page renders correctly
  • Verify the translate endpoint page still auto-renders from the OpenAPI spec
  • Check that no broken links remain in the docs/ tree

🤖 Generated with Claude Code

Retire api-reference/translate.mdx (537-line overview). Unique content
(model_type guidance, batching strategies, sentence splitting, in-text
markup, code examples) routed to a new how-to page at
docs/learning-how-tos/examples-and-guides/translating-text.mdx.

Endpoint page stays as clean OpenAPI stub. Parameter descriptions
discarded (covered by OpenAPI spec auto-rendering).

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
@shirgoldbird shirgoldbird force-pushed the docs/pipeline-20260707-215756-retire-translate-overview branch from 31fe5d7 to f894a04 Compare July 8, 2026 15:49
/api-reference/translate → /docs/learning-how-tos/examples-and-guides/translating-text

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
@mintlify

mintlify Bot commented Jul 8, 2026

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
deepl-c950b784 🟢 Ready View Preview Jul 8, 2026, 3:54 PM

💡 Tip: Enable Workflows to automatically generate PRs for you.

…roup

Remove spurious 'learning-how-tos' top-level group that promote.py created,
place the page in the correct existing nested group instead.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant