Skip to content

docs: Deprecate SDK docs and consolidate to serverless documentation#542

Open
promptless[bot] wants to merge 4 commits intomainfrom
promptless/deprecate-sdk-docs
Open

docs: Deprecate SDK docs and consolidate to serverless documentation#542
promptless[bot] wants to merge 4 commits intomainfrom
promptless/deprecate-sdk-docs

Conversation

@promptless
Copy link
Contributor

@promptless promptless bot commented Feb 23, 2026

Open this suggestion in Promptless to view citations and reasoning process

Removes the SDK tab from the documentation and consolidates SDK content into the existing serverless documentation:

  • New page: serverless/sdks.mdx - A consolidated guide for installing the Runpod SDK in Python, JavaScript, and Go.
  • Updated: serverless/endpoints/send-requests.mdx - Added missing Go health check example.
  • Deleted: 19 redundant SDK files including sdks/python/, sdks/javascript/, sdks/go/ directories and all Python SDK tutorials in tutorials/sdks/python/.
  • Navigation: Removed SDK tab from docs.json and added redirects to prevent broken links.
  • Preserved: GraphQL docs remain in sdks/graphql/ as they document the GraphQL API, not language SDKs.

Trigger Events

Internal discussion about rewriting and consolidating SDK documentation, with plans to deprecate the SDK docs section and merge relevant content into the Serverless documentation.

Agent Response

I've completed the SDK documentation deprecation and consolidation. Here's a summary of what was done:

Summary

I created one suggestion that addresses all your requirements:

Changes Made

New Documentation:

  • Created get-started/install-sdks.mdx - A consolidated guide covering Python, JavaScript, and Go SDK installation with API key configuration

Updated Documentation:

  • Added the missing Go health check example to serverless/endpoints/send-requests.mdx (as you noted was missing)

Deleted Content (19 files):

  • sdks/python/ - overview.mdx, endpoints.mdx, apis.mdx
  • sdks/javascript/ - overview.mdx, endpoints.mdx
  • sdks/go/ - overview.mdx, endpoints.mdx
  • tutorials/sdks/python/ - All 12 tutorial files

Navigation Updates:

  • Removed the SDK tab from the docs navigation
  • Added the new SDK installation guide to the "Get started" section
  • Added redirects for all deleted pages to prevent broken links:
    • SDK overview pages → /get-started/install-sdks
    • SDK endpoint pages → /serverless/endpoints/send-requests
    • Python APIs page → /api-reference/overview
    • Python tutorials → /serverless/workers/handler-functions

Preserved:

  • sdks/graphql/ directory remains untouched since it documents the GraphQL API (separate from language SDKs)

Rationale

The serverless/endpoints/send-requests.mdx page already contained comprehensive examples for all three languages (Python, JavaScript, Go) covering all endpoint operations. The SDK docs were largely redundant with this existing documentation. The Python tutorials overlapped significantly with the serverless/workers/ documentation.

The suggestion is ready for your review. Let me know if you'd like any adjustments!


Tip: Worried about broken links? Ask Promptless to find and fix them automatically 🔗

log.Fatalf("Failed to create endpoint: %v", err)
}

health, err := endpoint.Health()
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Citation: Added Go health check example that was missing from the SDK documentation. The client specifically noted that "Go is missing a health check example." Example pattern based on existing Go examples in sdks/go/endpoints.mdx.
View source

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