Skip to content

docs: Add comprehensive SDK documentation #39

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
nicolasiscoding merged 6 commits into from
Dec 11, 2025
Merged

docs: Add comprehensive SDK documentation #39

nicolasiscoding merged 6 commits into from
Dec 11, 2025

Conversation

@nicolasiscoding
Copy link
Member

@nicolasiscoding nicolasiscoding commented Nov 24, 2025

Summary

  • Add new SDKs section with world-class developer documentation for all 6 official TurboDocx SDKs
  • Create detailed documentation pages for JavaScript/TypeScript, Python, Go, .NET, Java, and Ruby
  • Update existing TurboSign pages with SDK references and multi-language code examples

New Documentation

SDK Overview Hub (/docs/SDKs)

  • Quick installation table for all 6 languages
  • Language-agnostic quick start guide with code tabs
  • Core features overview (TurboSign methods)
  • Field positioning explanations (coordinate vs template-based)
  • Error handling patterns

Language-Specific Pages

Each SDK page includes:

  • Installation instructions (multiple package managers)
  • Configuration setup
  • Quick start examples
  • Full API reference
  • Framework-specific examples:
    • JavaScript: Express.js, Next.js, NestJS
    • Python: FastAPI, Django, Flask
    • Go: net/http, Gin
    • .NET: Minimal API, Controllers, DI setup
    • Java: Spring Boot, Maven/Gradle
    • Ruby: Rails, Sidekiq
  • Error handling patterns
  • Webhook signature verification
  • Type definitions/models

Updates to Existing Pages

TurboSign API Signatures

  • Added SDK callout box with quick install commands and links

TurboSign Webhooks

  • Added multi-language SDK verification examples with code tabs

Sidebar Changes

  • Added new "SDKs" category right after "Welcome to TurboDocx"
  • Configured proper document IDs and labels for all SDK pages

Test plan

  • Build docs site locally (npm run build)
  • Verify all SDK pages render correctly
  • Check sidebar navigation works
  • Verify code tabs work on SDK pages
  • Test internal links between pages

🤖 Generated with Claude Code

@nicolasiscoding @claude @AmitSharma512
docs: add comprehensive SDK documentation
044a666 
- Create new SDKs section with overview hub page
- Add detailed documentation for all 6 SDKs:
  - JavaScript/TypeScript with Express, Next.js, NestJS examples
  - Python with FastAPI, Django, Flask examples
  - Go with HTTP handlers and Gin examples
  - .NET with ASP.NET Core minimal API and controller examples
  - Java with Spring Boot examples
  - Ruby with Rails and Sidekiq examples
- Update sidebars.js to include SDKs category
- Add SDK reference callout to TurboSign API Signatures page
- Add multi-language SDK webhook verification examples to Webhooks page

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

Co-Authored-By: Claude <noreply@anthropic.com>
@AmitSharma512 AmitSharma512 force-pushed the feat/sdk-documentation branch from 7c4a8c1 to 044a666 Compare December 9, 2025 14:14
@AmitSharma512 AmitSharma512 marked this pull request as ready for review December 10, 2025 16:34
@nicolasiscoding nicolasiscoding merged commit 6756e5a into develop Dec 11, 2025
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@nicolasiscoding @AmitSharma512