TurboDocx / TurboDocx/SDK

Publish the Ruby gem (turbodocx-sdk) to RubyGems

Open
#45 1 comment 0 reactions 1 assignee View on GitHub

@nicolasiscoding is already working on this.

Since Jul 21, 2026.

Dominant language
PHP
Stars
1
Forks
0
Avg merge
12h 19m
Merged PRs (30d)
2

Description

Summary

The Ruby SDK is implemented and tested in packages/ruby-sdk/, but the turbodocx-sdk gem has never been published to RubyGems. Anyone following the docs and running gem install turbodocx-sdk gets a failure.

Because of that, the Ruby documentation pages are currently hidden from the published docs site (draft: true) — see TurboDocx/Docs#118. They stay hidden until this ships.

Prerequisite — the publish secret

Per docs/ARCHITECTURE.md, publish-ruby.yml pushes via the RUBYGEMS_API_KEY repo secret, and that secret must be configured before the first gem release:

  • Create a RubyGems API key with push scope for turbodocx-sdk
  • Add it as the RUBYGEMS_API_KEY repo secret

Publish

  • Confirm the version in both Ruby version sites is correct and matches the other SDKs (per .claude/rules/versioning.md, Ruby carries the version twice):
    • packages/ruby-sdk/turbodocx-sdk.gemspecspec.version
    • packages/ruby-sdk/lib/turbodocx_sdk.rbVERSION =
  • bundle exec rspec green
  • Cut the ruby-sdk-v* release tag (the publish workflow is guarded to that tag prefix)
  • Verify the gem is live: gem install turbodocx-sdk from a clean environment

After publishing — un-hide the docs

In the Docs repo:

  • Remove draft: true (and the accompanying comment) from the 5 Ruby pages: ruby.md, deliverable-ruby.md, quote-ruby.md, webhooks-ruby.md, partner-ruby.md
  • Restore the Ruby entries in sidebars.js for the 4 public SDK categories only: TurboSign, Deliverable, TurboWebhooks, TurboQuote.
    Do NOT add a TurboPartner entry — TurboPartner is a gated/sales-led program (separate TDXP- credentials) and is intentionally kept out of the sidebar, search and sitemap (see Docs commit 1032df9).
  • partner-ruby.md: replace draft: true with unlisted: true so it matches its js/py/php/go/java siblings — reachable by direct URL for partners, but not listed. Do not add it to the sidebar or the index.
  • Restore the Ruby rows in the 5 SDK tables on docs/SDKs/index.md, plus the Ruby install/code tabs
  • Restore the Ruby tab in docs/TurboSign/Webhooks.md
  • Re-add ruby sdk / "and Ruby" to the index frontmatter description + keywords

The hiding commit documents exactly what to reverse.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.