docs: credit Omar Aljarrah in LICENSE and showcase the SDK in README - #108
Merged
Merged
Conversation
LICENSE now reads "Copyright (c) 2026 dexpace and Omar Aljarrah", matching the Node SDK's text; all six per-gem copies are updated so they stay byte-identical to the root file (gem_layout_test.rb). README follows the Node SDK's shape: badges, the gem table and install snippet, a quick start (minimal request, JSON POST, a standard pipeline with bearer auth, bodies, pagination, SSE, three-state PATCH, the async path), the stage diagram and layers, the core namespace table, highlights, development, conventions and the release blockers. Every example was run against a local server on Ruby 4.0.6 under ruby -w.
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
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.
What and why
This PR brings the root
LICENSEandREADME.mdin line with the Node SDK's (dexpace/nodejs-sdk).Copyright (c) 2026 dexpace and Omar Aljarrah, and the wording and wrapping match Node's. All sixgems/*/LICENSEcopies are updated too, so they stay byte-identical to the root file.Pipeline.standardwith a bearer-auth step, request bodies, pagination, SSE, three-state PATCH and the async pathdexpace-corenamespacesCODE_OF_CONDUCT.md,CONTRIBUTING.mdandSECURITY.mdalready follow Node's versions section for section, so they are unchanged.Requirements
None. This is documentation and licensing only.
Verification
rake gates:reproducibleandgates:gemspec_auditare green, andtest/gates/gem_layout_test.rbpasses (per-gem LICENSE byte-identity), on Ruby 4.0.6sig/and the surface snapshot: n/a, no public surface changeruby .claude/skills/housekeeping/probe.rbexits 0ruby -won 4.0.6 against a local HTTP server. The auth example ran over a fakehttpstransport instead, because the AUTH step refuses plaintext.The full
bundle exec rakewas not run locally.Records
docs/product-spec/ordocs/sdk-design-ruby/was edited