docs: rename 'sidecar' to 'local PMXT service' per 2026-05-27 ADR (v2.49.2)#980
Open
realfishsam wants to merge 1 commit into
Open
docs: rename 'sidecar' to 'local PMXT service' per 2026-05-27 ADR (v2.49.2)#980realfishsam wants to merge 1 commit into
realfishsam wants to merge 1 commit into
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. |
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.
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.