docs: remove in-repo SDK scaffolds, point to facet-llc/sdk - #4
Open
lynz-tonomi wants to merge 1 commit into
Open
docs: remove in-repo SDK scaffolds, point to facet-llc/sdk#4lynz-tonomi wants to merge 1 commit into
lynz-tonomi wants to merge 1 commit into
Conversation
…/sdk The spec repo's sdks/typescript (@facet/sdk-js) and sdks/python (facet-sdk) were 0.0.1 scaffolds under the wrong scope, duplicating and diverging from the published @Facet-llc packages in github.com/facet-llc/sdk. Remove them and repoint every reference (README, ARCHITECTURE, AUDIT, SECURITY, CHANGELOG, test-vectors). CI drops the two SDK jobs; the vectors job remains. Also scrub 'leading verifier' -> 'a verifier' in the README. This repo stays the protocol surface: SPEC.md, schemas/, test-vectors/.
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
1 participant
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
Remove the in-repo SDK scaffolds (
sdks/typescript→@facet/sdk-js,sdks/python→facet-sdk, both0.0.1) and point every reference at the canonical SDK repo,github.com/facet-llc/sdk.Why
The scaffolds were placeholder
0.0.1packages under the wrong scope (@facet, not@facet-llc) and were neither published nor kept in sync with the real, published packages infacet-llc/sdk:@facet-llc/protocol(0.3.2),@facet-llc/client(0.2.4),@facet-llc/sdk-node(0.1.3), plus the payment-rail adapters and origination verifiers — all live on npm under@facet-llc/*.Shipping a second, divergent, mis-scoped SDK in the spec repo created a "which package do I install?" trap next to the canonical one. This repo should be the protocol surface; the SDK lives in its own repo.
Changes
sdks/typescript/andsdks/python/; left asdks/README.mdbreadcrumb redirecting tofacet-llc/sdkso existing links don't 404.README.md,ARCHITECTURE.md(prose, the layer diagram, and the SDK-shape section),AUDIT.md,SECURITY.md(vuln scope),CHANGELOG.md, andtest-vectors/README.md.sdk,sdk-python); thevectorsshape-sanity job remains.Scope unchanged
SPEC.md,schemas/, andtest-vectors/are untouched — this repo remains the spec, schemas, and conformance vectors.