docs: fix package imports and Kalshi SDK examples - #2316
Open
mikevillari wants to merge 2 commits into
Open
Conversation
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.
The two guides import TypeScript examples from the nonexistent
pmxtnpm package. This fixes their package imports and keeps each guide aligned with the actual exported API.Closes #2313.
pmxt-core, which exports the documentedBaseError,NotFound, and HTTPstatusproperty. Simply replacing these imports withpmxtjswould leave missing exports. Added an explicit package distinction and link to the SDK error reference.pmxtjs,Kalshi/KalshiDemo, and flat constructor options. Removed a duplicateconst kalshideclaration and included the required outcome ID placeholder.InstanceType<typeof Polymarket>because the core convenience export is a constructor value.Validation: extracted all 16 TypeScript fences and checked them against the checkout's real public entry points with TypeScript (ES2022/ESNext/bundler, strict, useUnknownInCatchVariables=false for the guides' existing catch examples). Original snippets produced 18 diagnostics; updated snippets have zero snippet-level diagnostics. Two dependency diagnostics remain because the checkout lacks
sdks/typescript/generated/src/index.js. The attempted SDK build fails for those same missing generated imports; full-project compilation is not claimed.git diff --checkpasses.Documentation only. No examples, exchange requests, or orders executed. The root integration suite, which starts a sidecar and performs real integration checks, was not run; full tests remain a merge gate. AI-assisted source verification and editing.