Skip to content

docs: rename 'sidecar' to 'local PMXT service' per 2026-05-27 ADR (v2.49.2)#980

Merged
realfishsam merged 1 commit into
mainfrom
docs/rename-sidecar-to-local-service
Jun 9, 2026
Merged

docs: rename 'sidecar' to 'local PMXT service' per 2026-05-27 ADR (v2.49.2)#980
realfishsam merged 1 commit into
mainfrom
docs/rename-sidecar-to-local-service

Conversation

@realfishsam

Copy link
Copy Markdown
Contributor

Sweeps every user-visible "sidecar" reference in the recently-shipped docs/READMEs/changelog to the canonical "local PMXT service" / "local service" per the 2026-05-27 company-brain ADR "Avoid Sidecar Terminology".

What's in this PR

  • READMEs (root, Python, TypeScript) — Quick Start, "How it works (self-hosted)", and "Self-hosted trading (advanced)" sections updated.
  • docs/concepts/hosted-vs-self-hosted.mdx — one bullet updated.
  • changelog.md — 2.49.0 + 2.49.1 entries' prose rewritten. Historical entries for 2.48.x and earlier intentionally untouched.
  • New 2.49.2 entry documenting this cleanup.

Untouched per ADR scope

  • Internal implementation identifiers (_resolve_sidecar_host, sidecarReadRequest, etc.)
  • Auto-generated artifacts (openapi.json, llms-full.txt) — flow through next regen
  • Historical changelog entries (2.48.x and earlier) — describe what shipped at the time

Coordination note

PR #979 (per-method hosted toggle) currently targets 2.49.2. Whichever PR lands second needs to renumber to 2.49.3 at rebase time. Recommend landing this one first since it's small + pure docs.

….49.2)

Per the company-brain ADR 'Avoid Sidecar Terminology' (2026-05-27),
user-facing references to the local PMXT runtime should not use the
word 'sidecar' — preferred phrasing is 'local PMXT service' (primary)
or 'local service' (when context is unambiguous).

Recent docs/READMEs/changelog content shipped in 2.49.0 / 2.49.1 used
the old term reflexively. This sweep rewrites every user-visible
occurrence to the canonical terms:

- readme.md (root)
- sdks/python/README.md (rendered on PyPI)
- sdks/typescript/README.md (rendered on npm)
- docs/concepts/hosted-vs-self-hosted.mdx
- changelog.md (only the 2.49.0 + 2.49.1 entries; historical entries
  for 2.48.x and earlier stay as-is per the ADR's 'leave history
  alone' principle)

Untouched per ADR scope:
- Internal implementation identifiers (_resolve_sidecar_host,
  _kill_orphan_sidecars, sidecarReadRequest, pmxt-ensure-server, ...)
- Auto-generated files (docs/api-reference/openapi.json,
  docs/llms-full.txt, docs/llms.txt) — flows through next regen

Adds 2.49.2 changelog entry documenting the cleanup.

Coordination note: PR #979 (per-method hosted toggle) currently uses
2.49.2 as its target version. Whichever PR merges second will need to
renumber to 2.49.3 at rebase time.
@mintlify

mintlify Bot commented Jun 8, 2026

Copy link
Copy Markdown

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
PMXT 🟢 Ready View Preview Jun 8, 2026, 9:40 PM

💡 Tip: Enable Workflows to automatically generate PRs for you.

@realfishsam

Copy link
Copy Markdown
Contributor Author

PR Review: PASS (NOT VERIFIED)

What This Does

This is a documentation-only terminology sweep replacing user-facing “sidecar” language with “local PMXT service” / “local service” in current docs, READMEs, and recent changelog entries. It matters to SDK consumers because it aligns self-hosted setup language across PyPI/npm README surfaces and the docs site.

Blast Radius

Docs/README/changelog copy only: root readme.md, Python and TypeScript SDK READMEs, docs/concepts/hosted-vs-self-hosted.mdx, and current changelog entries. No runtime code, generated SDKs, OpenAPI schemas, router, exchange logic, or auth paths changed.

Consumer Verification

Before (base branch):
The changed user-facing files still used “sidecar” in current self-hosting copy, e.g. root readme.md described omitting pmxt_api_key as “The SDK spawns a local sidecar process,” and docs/concepts/hosted-vs-self-hosted.mdx said “run a sidecar.”

After (PR branch):
I checked the changed user-facing files on PR f441e7e0eac25276e9dc21cbe13867055127eaaf. The READMEs and hosted-vs-self-hosted concept page now have zero remaining sidecar matches, and the current copy uses “local PMXT service” / “local service” instead. changelog.md still has historical/internal-scope occurrences, which matches the PR’s stated “leave historical entries and implementation identifiers alone” scope.

Test Results

  • Build: PASS (npm run build --workspace=pmxt-core)
  • Unit tests: NOT RUN — docs-only change; no runtime path changed.
  • Server starts: NOT RUN — docs-only change.
  • E2E smoke: PASS (copy/grep verification of changed user-facing docs surfaces)

Findings

No blocking findings.

PMXT Pipeline Check

  • Field propagation (3-layer): N/A
  • OpenAPI sync: N/A — generated artifacts intentionally untouched.
  • Financial precision: N/A
  • Type safety: N/A
  • Auth safety: N/A

Semver Impact

patch -- documentation terminology cleanup only.

Risk

PR #979 also claims version 2.49.2; whichever PR merges second will need a changelog/version rebase to avoid two separate 2.49.2 entries. I did not verify the external company-brain ADR text directly, only that the repository changes match the PR’s stated ADR scope.

@realfishsam realfishsam merged commit 69c7548 into main Jun 9, 2026
8 of 12 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant