Skip to content

Create SDK Documentation Pages with Improved Titles and Discoverability #47

@nicolasiscoding

Description

@nicolasiscoding

Overview

Create documentation pages for signing/generating documents with TurboDocx SDK across all supported languages. Each page should have clear, action-focused titles and descriptions to help developers find what they need.

Languages to Cover

  1. PHP - /docs/SDKs/php
  2. Python - /docs/SDKs/python
  3. JavaScript - /docs/SDKs/javascript
  4. Java - /docs/SDKs/java
  5. Go - /docs/SDKs/go

Page Structure Guidelines

Required Metadata

Each page should include:

---
title: Sign Documents with {Language} | TurboDocx
description: Learn how to sign documents with {Language} using TurboDocx...
keywords:
  - sign documents {language}
  - sign pdf {language}
  - esignature api {language}
  - turbodocx {language} sdk
---

Heading Hierarchy

H1: Sign Documents with {Language}
  H2: Installation
  H2: Configuration
  H2: Quick Start
    H3: Send a Document for Signature
    H3: Using Template-Based Fields
  H2: File Input Methods
  H2: API Reference
  H2: Error Handling
  H2: Resources

Content Sections

1. Introduction

Brief overview explaining what developers can accomplish with this guide.

2. Installation

  • Package installation command (composer/pip/npm/maven/go get)
  • Requirements

3. Configuration

  • Environment setup
  • Authentication

4. Quick Start

  • Full code example showing API call
  • Explain required parameters

5. Resources

  • Link to SDK GitHub repo
  • Link to API docs
  • Link to examples repository
  • Cross-links to other language guides

Checklist

  • Title under 60 characters
  • Description 150-160 characters
  • Unique intro paragraph per language
  • All internal links have title attributes
  • External links use rel="noopener noreferrer"

Reference

Modeled after: https://www.docuseal.com/guides/sign-pdf-with-php

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions