docs: state image architecture as region-dependent, not absolute - #1183
Merged
Conversation
Four pages assert that Pipecat Cloud requires linux/arm64, phrased as a
platform-wide constraint: "Pipecat Cloud only supports images for the
linux/arm64 platform", "requires all images to be built to target Linux
on ARM", "required for Pipecat Cloud deployments".
pipecatcloud 1.2.0 added `deploy --architecture {amd64,arm64}` and an
`architecture` key in pcc-deploy.toml, validated against what the target
region supports. Architecture is a property of the region now, not of the
platform.
Nothing here is wrong for a reader deploying today — Daily-hosted regions
run arm64 — so this states the rule that is actually true and names arm64
as the value that follows from it, rather than leaving four absolutes to
be contradicted later.
Scoped to the four pages that state it as absolute. The flag itself and
the pcc-deploy.toml key are already documented in #1145, and the three
container-registry guides say "the correct platform (linux/arm64)" about
`docker build-push`, which does build arm64 and cannot be changed.
Also adds the docker image inspect one-liner to error-codes, since the
first thing a reader hitting PCC_INVALID_IMAGE_PLATFORM needs is a way to
see what they actually built.
Contributor
|
🔍 Mintlify preview for this branch: https://daily-docs-architecture-is-region-dependent.mintlify.site |
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.
Four pages assert
linux/arm64as a platform-wide requirement.pipecatcloud1.2.0 made architecture a property of the region, so those absolutes are about to be contradicted by the docs' own content.fundamentals/error-codes.mdxlinux/arm64platform"fundamentals/agent-images.mdxapi-reference/cli/cloud/docker.mdxlinux/arm64… required for Pipecat Cloud deployments"guides/ci-with-github-actions.mdxlinux/arm64"1.2.0 added
deploy --architecture {amd64,arm64}and anarchitecturekey inpcc-deploy.toml, validated against what the target region supports.Nothing above is wrong for a reader deploying today — Daily-hosted regions run arm64. But each states the consequence as if it were the rule, so each becomes false the moment a region with a different architecture exists. This states the rule and names arm64 as what follows from it.
Scope
Deliberately narrow, because #1145 is in flight and touches adjacent ground:
deploy.mdx. docs(cloud): self-hosted regions #1145 already documents--architecture, thearchitectureTOML key,--resources, and[resources]there. I'd previously recommended splitting the deploy-side flag out and doing it separately — that was wrong, it's covered.linux/arm64)". Those describedocker build-push, which does build arm64 and can't be configured otherwise.Phrasing avoids depending on content #1145 introduces — no reader is sent to a
regions listarchitecture column that doesn't exist yet.One addition
error-codes.mdxgains a one-liner forPCC_INVALID_IMAGE_PLATFORM:The first thing someone hitting that error needs is a way to see what they actually built; the page previously only told them what was required.
Verification
mint broken-links --check-anchors --check-redirectsclean,docs-meta-lint.mjs0 errors,llms-full.txtregenerated.🤖 Generated with Claude Code