docs: rename 'sidecar' to 'local PMXT service' per 2026-05-27 ADR (v2.49.2)#980
Conversation
….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.
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
PR Review: PASS (NOT VERIFIED)What This DoesThis 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 RadiusDocs/README/changelog copy only: root Consumer VerificationBefore (base branch): After (PR branch): Test Results
FindingsNo blocking findings. PMXT Pipeline Check
Semver Impactpatch -- documentation terminology cleanup only. RiskPR #979 also claims version |
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
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.Untouched per ADR scope
_resolve_sidecar_host,sidecarReadRequest, etc.)openapi.json,llms-full.txt) — flow through next regenCoordination 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.