Improve SDK documentation titles and discoverability #48
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
This PR adds Stripe/PostHog-like elegant documentation for the TurboDocx PHP SDK. ## What's New ### New Documentation - **docs/SDKs/php.md** (791 lines) - Complete PHP SDK documentation with modern PHP 8.1+ patterns ### Updated Files - **docs/SDKs/index.md** - Added PHP to all code examples and SDK comparison table - **sidebars.js** - Added PHP SDK to navigation menu ## Key Features - Progressive complexity (simple → advanced examples) - Modern PHP 8.1+ features (enums, named parameters, readonly classes) - Both manual and `HttpClientConfig::fromEnvironment()` configuration - All 7 API methods fully documented - 11 field types with PHP enum examples - Comprehensive error handling with typed exceptions - Strategic use of admonitions (tips, warnings, info boxes) - Error handling warnings in Quick Start section ## Documentation Highlights - **Installation**: Composer integration - **Configuration**: Manual and environment-based setup - **Quick Start**: Coordinate-based and template-based examples - **File Input Methods**: 4 ways to provide documents - **API Reference**: Complete method documentation - **Field Types & Positioning**: Full coverage with examples - **Error Handling**: PHP-specific exception patterns - **Type Safety**: PHP 8.1+ enums and readonly classes ## Quality Assurance All critical issues from code review addressed: - ✅ Accurate API method signatures - ✅ Correct response object properties - ✅ Proper PHP type hints and enums - ✅ Consistent with existing SDK documentation patterns - ✅ Error handling best practices Co-Authored-By: Claude Sonnet 4.5 <[email protected]>
Fixed multiple technical inaccuracies found in code review: - Fix DocumentStatus enum - added missing values (draft, setup_complete, review_ready, under_review) to match SDK implementation - Remove 'readonly' keyword from class declarations (Recipient, Field, SendSignatureRequest) - SDK uses 'final class' not 'final readonly class' - Fix AuditTrail property access from $audit->entries to $audit->auditTrail - Add missing parameters to SendSignatureRequest type reference (fileName, senderName, senderEmail) - Add missing imports to 7 code examples: - Template-based Quick Start example - File Upload (Direct) example - File URL example - TurboDocx Deliverable ID example - TurboDocx Template ID example - Prepare for review API example - Prepare for signing API example All fixes verified against SDK source code. Related: #44
Fixed TypeScript type documentation that incorrectly used N8nRecipient and N8nField instead of the correct SDK types Recipient and Field. Changes: - Renamed N8nRecipient -> Recipient (header, import, and table reference) - Renamed N8nField -> Field (header, import, and table reference) The N8n prefix was likely a copy-paste artifact from n8n community node development and does not match the actual SDK type exports. Related: #44
nicolasiscoding
changed the title
Update all SDK documentation pages with clearer titles and descriptions:
- Update page titles to action-focused format: "Sign Documents with {Language}"
- Enhance descriptions to clearly explain what each guide covers
- Expand keywords to help developers find documentation
- Update H1 headings to match page titles
- Add intro paragraphs explaining guide purpose
Languages updated:
- JavaScript/TypeScript
- Python
- PHP
- Go
- Java
Closes #47
Co-Authored-By: Claude Opus 4.5 <[email protected]>
nicolasiscoding
force-pushed
the
feature/sdk-seo-enhancements
branch
from
4f2c66a to
9b48fa1
Compare
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
Enhances all SDK documentation pages with clearer, action-focused titles and descriptions that better communicate what each guide helps developers accomplish.
Changes
Languages Updated
npm install @turbodocx/sdkpip install turbodocx-sdkcomposer require turbodocx/sdkgo get github.com/TurboDocx/SDK/packages/go-sdkimplementation 'com.turbodocx:turbodocx-sdk:0.1.4'Why These Changes
Test Plan
Related
Closes #47
🤖 Generated with Claude Code