docs: restructure IA around product lines (Phase 1)#300
Draft
shirgoldbird wants to merge 4 commits intomainfrom
Draft
docs: restructure IA around product lines (Phase 1)#300shirgoldbird wants to merge 4 commits intomainfrom
shirgoldbird wants to merge 4 commits intomainfrom
Conversation
Reorganize ~95 documentation pages from topic-based sections (Getting Started, Best Practices, XML and HTML Handling, Resources) into product-line sections (Translate API, Admin API) with cross-cutting sections (Going to Production, Cookbooks, Changelog). Documentation tab changes: - Dissolve Best Practices, Learning & How-Tos, XML and HTML Handling, and Resources sections - Create Translate API section with subsections: Text Translation, Document Translation, Customizations, Structured Content, Languages - Create Admin API, Going to Production, Cookbooks, Changelog sections - Add Test with Postman to Developer Tools group - Add Enable Beta Languages to nav (was hidden) API Reference tab changes: - Replace single "API Reference" group with product-line top-level groups: Translate API, Write API, Voice API, Admin API - Rename "Translate Speech in Realtime" to "Voice API" - Add DEPRECATED tag to Monolingual Glossaries v2 group - Add BETA tag to v3 Languages group - Add service specification updates pages for Write and Voice APIs Also: - Add "API Pricing" and "Manage Keys" to navbar - Add 69 redirects from old URLs to new locations - Fix 11 broken internal links caused by page moves Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
- Move Languages from Translate API to Getting Started (docs tab) and Admin API (API Reference tab) - Move Admin API overview to first position in API Reference listing - Remove service specification update pages from Write and Voice API sidebar nav - Rename "Monolingual Glossaries v2" to "Glossaries v2" - Nest GET usage analytics under Organization usage analytics group - Move Changelog from standalone section to page under Getting Started - Rename page title from "Roadmap and release notes" to "Changelog" Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Previously hidden pages are now visible in the nav: - XML page: added to renamed "XML & HTML" group (was "Structured Content") - Developer Community: moved to Developer Tools group - OpenAPI spec: moved to Developer Tools group - Alpha and beta features: moved to new "Updates" group - Breaking changes: moved to "Updates" group, renamed from "Breaking changes (Change Notices)" to "Breaking changes" - Changelog, alpha/beta, and breaking changes grouped under "Updates" in Getting Started Also: - Remove DeepL 101 reference from intro page (page stays hidden for Phase 2 merge) - Update stale cookbook/guides links on intro page - Fix internal links in breaking changes overview page Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
- Languages: break out from Getting Started into its own top-level section in the Documentation tab - API Updates: promote from nested group under Getting Started to top-level section containing Changelog, Alpha and beta features, and Breaking changes Documentation tab now has 7 top-level groups: Getting Started, Languages, Translate API, Admin API, Going to Production, Cookbooks, API Updates Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Implements Phase 1 of the docs IA proposal: reorganize the Documentation and API Reference tabs around product lines instead of topic-based sections.
What this does NOT change
Pages hidden from nav (still exist as files)
docs/getting-started/about.mdx— folded into Introduction in Phase 2docs/learning-how-tos/examples-and-guides/first-things-to-try-with-the-deepl-api.mdx— merged into Your first API request in Phase 2docs/xml-and-html-handling/xml.mdx— merged into Handle XML content in Phase 2docs/resources/breaking-changes-change-notices/— linked from Changelog pagedocs/resources/alpha-and-beta-features.mdx— linked from Changelog pagedocs/resources/deepl-developer-community.mdx— banner/footer linkdocs/resources/open-api-spec.mdx— linked from Client libraries pageTest plan
🤖 Generated with Claude Code