Skip to content

Publish the Ruby gem (turbodocx-sdk) to RubyGems #45

Closed

Description

@nicolasiscoding

Summary

The Ruby SDK is implemented and tested in packages/ruby-sdk/. Update 2026-10-21: the turbodocx-sdk gem is now live on RubyGems — turbodocx-sdk 0.9.0, pushed 2026-10-20 with the ruby-sdk-v0.9.0 release. What's left is the docs: the Ruby pages are still hidden (draft: true, see TurboDocx/Docs#118) and must come back in the current SDK docs design.

Docs PR: TurboDocx/Docs#227. Close this issue once it's merged.

Publish

  • Version matches the other SDKs in both Ruby version sites — 0.9.0 in turbodocx-sdk.gemspec (spec.version) and lib/turbodocx_sdk.rb (VERSION) on the ruby-sdk-v0.9.0 tag
  • Tests green — CI on main passed at the release commit
  • ruby-sdk-v0.9.0 release tag cut (2026-10-20)
  • Gem is live — RubyGems lists turbodocx-sdk 0.9.0 and turbodocx-sdk-0.9.0.gem downloads
  • Note: the Publish Ruby SDK workflow run for that tag failed (the gemspec requires MFA on push), so 0.9.0 was pushed by hand. Publishing from CI is tracked separately in ci(ruby): publish to RubyGems with trusted publishing #134, so it doesn't block this issue.

Docs — bring Ruby back in the current SDK docs design

The un-hide checklist that was here predates TurboDocx/Docs#184 / #185, which replaced the per-language SDK pages with one tabbed page per product (<Tabs groupId="language" queryString>) plus a short setup page per language. #184 already planned for this: "the Ruby drafts (they get a Ruby tab when the gem is published)". So Ruby comes back the same way the other five languages were merged, not by un-drafting the old pages:

Ruby tabs in the product pages (<TabItem value="ruby" label="Ruby" attributes={{className: 'tab-lang tab-lang--ruby'}}>, after Java, in every language tab group):

  • docs/SDKs/turbosign.md — from the TurboSign content of ruby.md
  • docs/SDKs/deliverable.md — from deliverable-ruby.md
  • docs/SDKs/quote.md — from quote-ruby.md
  • docs/SDKs/webhooks.md — from webhooks-ruby.md
  • Every Ruby section checked against the published 0.9.0 gem; add Ruby for anything the other tabs cover that the old Ruby pages never had (the drafts have been hidden since July — e.g. quote apply_price_book / decline_quote / void_quote / reminders, template signer roles)

Language setup page

  • docs/SDKs/ruby.md becomes a setup page like javascript.md / python.md (Installation, Requirements, Configuration, Product guides, Resources), un-drafted, in the sidebar's language list

Retire the old per-product Ruby pages

  • Delete deliverable-ruby.md, quote-ruby.md, webhooks-ruby.md once their content is in the tabs
  • static/_redirects: 301 each old URL (plain, / and .html variants) to ?language=ruby on the product page, like the other languages

TurboPartner

  • partner-ruby.md: replace draft: true with unlisted: true to match its js/py/php/go/java siblings — reachable by direct URL, not in the sidebar, search or index (TurboPartner is gated; see Docs commit 1032df9)

Index and cross-links

  • docs/SDKs/index.md: Ruby rows in the SDK tables, Ruby install/code tabs, "and Ruby" + ruby sdk in the description and keywords
  • docs/TurboSign/Webhooks.md: Ruby tab (added in #227)
  • Remove every "the turbodocx-sdk gem is not on RubyGems yet" note (e.g. docs/TurboSign/embedded-signing/index.md, the Webhooks Ruby tab) and the hidden-page comments
  • docusaurus build passes with no new broken links or anchors; the markdown twins include the Ruby tabs

Activity

  1. nicolasiscoding commented on Jul 21, 2026

    @nicolasiscoding
    MemberAuthor

    Docs side is prepared: the five Ruby SDK pages are hidden (draft: true) pending this gem release — TurboDocx/Docs#118 (change record: TurboDocx/Docs#120).

    The un-hide checklist in this issue matches what that PR did, including keeping partner-ruby.md gated (unlisted: true) rather than adding it to the sidebar/index.

  2. amitsharma-turbodocx commented on Oct 21, 2026

    @amitsharma-turbodocx
    Contributor

    Done. The turbodocx-sdk gem is live on RubyGems (0.9.0), and the Ruby docs are back in the current SDK docs design via TurboDocx/Docs#227 (merged into develop): Ruby tabs on the TurboSign, Deliverable, TurboQuote and TurboWebhooks pages, a Ruby setup page in the sidebar, partner-ruby unlisted, the old per-product Ruby pages redirected to ?language=ruby, and the "not on RubyGems yet" notes removed. Every Ruby call was checked against the 0.9.0 gem. The docs go live on docs.turbodocx.com with the next develop → main docs release. Publishing the gem from CI is tracked separately in #134.

    🤖 Generated with Claude Code

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

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