Reorganize SDK Deep dives section into smaller sections #2932
+39
−19
Conversation
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
Break up the large Deep dives section into three smaller, focused sections: - Configuration: global headers, auto-pagination, idempotency, retries, README - Customization: SDK user features, method names, dynamic auth, audiences - Development: local previews, testing, self-hosted This matches the organizational pattern used in the Docs product navigation.
Contributor
Author
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
Note: I can only respond to comments from users who have write access to this repository. ⚙️ Control Options:
|
Contributor
|
Assignee Required This PR was opened by Devin AI but the requester's email ([email protected]) is not in the username mapping. Please add an assignee manually. |
Contributor
Reorganize the Deep dives section into five focused sections based on actual page content: - Generated SDK: SDK user features and README customization - SDK interface: Method names and audience filtering - Request behavior: Headers, auth, pagination, idempotency, retries - Preview & testing: Local previews and testing - Hosting: Self-hosted SDKs (Enterprise) Preserves existing /sdks/deep-dives/* URLs via explicit slugs for backward compatibility.
Contributor
Contributor
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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
Breaks up the large "Deep dives" section in the SDK docs navigation into five smaller, focused sections based on actual page content:
All sections are collapsed by default. Existing
/sdks/deep-dives/*URLs are preserved via explicit slugs for backward compatibility.Updates since last revision
Reorganized from 3 sections to 5 sections after reviewing the actual content of each page to ensure sections better reflect what users will find:
Review & Testing Checklist for Human
/learn/sdks/deep-dives/testingstill work (URL preservation via slugs)Recommended test plan: Navigate to the SDK docs in the preview deployment, expand each of the five new sections, and click through a few pages to verify they load correctly. Also test a direct URL like
/learn/sdks/deep-dives/auto-paginationto confirm backward compatibility.Notes
Minor style fixes: Simplified some page titles (e.g., "Configure global headers" → "Global headers", "Configure auto-pagination" → "Auto-pagination") for cleaner navigation.
Link to Devin run: https://app.devin.ai/sessions/77667b587f5646668f0c05dfc8373ddd
Requested by: Fern Support ([email protected])