docs: hosted-default positioning + 11 new pages + READMEs + changelog (v2.49.1)#977
Merged
Merged
Conversation
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
…ython + TS SDK READMEs (2.49.1) Flips the three pmxt READMEs to lead with the hosted API (pmxt.dev/dashboard key + wallet_address + private_key constructor) and demotes the self-hosted sidecar to an "advanced" subsection. Mirrors the v2.49.0 positioning shift the docs site is doing in parallel. - readme.md: subtitle, "Why pmxt?" bullets (dropped "No API key required" anti-positioning bullet), Quickstart, Trading section, added new "Self-hosted" section. - sdks/python/README.md (rendered on PyPI): flipped top Note, Quick Start now uses pmxt_api_key + wallet_address, "How it works" split into hosted/self-hosted, "Authentication (for Trading)" renamed to "Trading" with hosted-recommended/self-hosted-advanced subsections. - sdks/typescript/README.md (rendered on npm): same treatment in TS, added EthersSigner note. - changelog.md: 2.49.1 entry covering the whole positioning-shift batch (READMEs + Mintlify docs + openapi schemas + marketing site, each shipping in its own PR).
realfishsam
force-pushed
the
docs/hosted-trading-positioning
branch
from
2c3b8b8 to
a377902
Compare
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.
Positioning-shift patch on top of v2.49.0. Flips the docs default from local-sidecar-first to hosted-PMXT-first; self-hosting becomes the advanced escape hatch.
What's in this PR
11 new MDX pages (Mintlify):
trading-quickstart,concepts/hosted-trading,concepts/hosted-vs-self-hosted,concepts/catalog-uuid-vs-venue-id,guides/escrow-lifecycle,guides/signing,guides/hosted-errors,guides/migrate-to-hosted-trading,guides/self-hosted,api-reference/errors,api-reference/configuration. Use-case-first headings, Python/TS/curl code groups, inline Warning/Note callouts.7 prose edits:
introduction.mdx(inverted "It runs two ways"),authentication.mdx(Hosted-writes subsection + SDK-exception column),security.mdx(Warning → Note),sdk/server.mdx(top banner),concepts/venues.mdx(Hosted-trading venues table),docs.json(new sidebar groups + redirects scaffold).3 READMEs flipped to hosted-default: root pmxt readme.md, sdks/python/README.md (PyPI), sdks/typescript/README.md (npm). Self-hosted preserved as "advanced" subsection.
changelog.md: 2.49.1 entry covering the whole positioning batch.
Sibling PR
OpenAPI schema fixes ship separately on
core/openapi-hosted-trading-fields(Order/UserTrade/Position/Balance enrichment fields, Position required-list trim, ErrorDetail expansion, ExchangeOptions schema). Marketing site fixes ship in pmxt-website.Test plan