Skip to content

docs: align service naming on "Resolver" instead of "Pipeline" - #195

Merged
anukiransolur merged 1 commit into
mainfrom
docs/pipeline-to-resolver
Aug 5, 2026
Merged

docs: align service naming on "Resolver" instead of "Pipeline"#195
anukiransolur merged 1 commit into
mainfrom
docs/pipeline-to-resolver

Conversation

@murayama-r

Copy link
Copy Markdown
Contributor

Why

Core Concepts › Services has a Pipeline section whose "Learn more about Pipeline →" link goes to the Resolver guide. Since the direction is to standardize on Resolver, this PR sweeps the whole docs set for leftover Pipeline naming.

What changed

Renamed the user-facing service name Pipeline → Resolver across:

  • getting-started/core-concepts/ (services, platform-architecture, workspace-application)
  • guides/ (resolver, application, secretmanager, events, executor, function, workflow, tailordb)
  • tutorials/index.md
  • reference/ (terminology, timeouts, platform-limits, outgoing-ip-addresses, cel-scripting, js-scripting, api-references)
  • .vitepress/config.mts site description, README.md

Bugs found during the sweep

Fix Detail
Nav ordering navItemOrder.guides in .vitepress/config/constants.ts still listed the removed pipeline guide instead of resolver, so the Resolver entry fell through to default ordering.
Broken link The "Chaining Queries" card on /tutorials linked to a non-existent pipelines page → now resolver.
Invalid config samples Three tailor.config.ts samples used an application.subgraphs array containing "pipeline". That key no longer exists in the SDK (services are declared as db / resolver / auth / …), so a plain rename would have left a sample that cannot work. They now match the shape documented in /sdk/configuration.
Stale prose The Resolver guide's Overview described the legacy declarative step model, which the same guide later says is replaced by the body function.

Deliberately left as pipeline

These are machine-readable identifiers the platform actually accepts — renaming them would make the docs wrong:

  • the pipeline TRN resource type and its examples in reference/concepts/trn.md
  • the pipeline.resolver.executed event type and the pipelines key in its payload
  • the CreatePipelineService API method name
  • "CI pipeline", OpenTelemetry pipelines, and tailor generate pipeline phases (unrelated senses)

Needs a second opinion (not touched)

  • Console pages (getting-started/console/overview.md, key-features.md) still say Pipeline because they describe literal Console UI labels ("select the Pipeline option") and the screenshots show it. These should be updated together with the Console UI — someone who can check the current Console should confirm. I did fix the link text on key-features.md line 33.
  • sdk/services/resolver.md has a "Comparison with Tailor Platform Pipeline Resolver" section contrasting the SDK resolver against the legacy YAML steps model. Renaming it would make the comparison incoherent; it probably wants deleting or rewriting instead.
  • sdk/cli/application.md"IdP / TailorDB / Pipeline endpoints" refers to OperatorService endpoint grouping, which may still be named Pipeline server-side.
  • getting-started/index.md"visualize pipelines" describes a Console feature; left alone for the same reason as the Console pages.
  • Separately, guides/static-website-hosting.md still uses the outdated defineTailorConfig({ workspace, app: { subgraphs } }) shape. Out of scope here — better handled by a full SDK sample sync.

Verification

pnpm typecheck, pnpm lint, pnpm fmt:check, and pnpm build all pass. The build resolves all internal links, so no dead links were introduced.

🤖 Generated with Claude Code

The Pipeline service is now documented as "Resolver" (the guide already
lives at /guides/resolver), but many pages still said "Pipeline" — most
visibly the Core Concepts › Services entry, whose "Learn more about
Pipeline →" link points at the Resolver guide.

Rename the user-facing service name across getting-started, guides,
tutorials, reference, the site description, and the nav ordering config.

Also fixed along the way:

- `navItemOrder.guides` in .vitepress/config/constants.ts still listed
  the removed `pipeline` guide instead of `resolver`, so the Resolver
  entry fell through to the default ordering.
- The "Chaining Queries" card on /tutorials linked to a non-existent
  `pipelines` page; it now points at `resolver`.
- Three `tailor.config.ts` samples used an `application.subgraphs`
  array containing `"pipeline"`. That key no longer exists in the SDK
  (services are declared as `db` / `resolver` / `auth` / …), so a plain
  rename would have left a sample that cannot work. They now match the
  shape documented in /sdk/configuration.
- The Resolver guide's Overview described the legacy declarative
  step model, which the guide itself later says is replaced by the
  `body` function.

Machine-readable identifiers keep the `pipeline` spelling, because that
is what the platform actually accepts:

- the `pipeline` TRN resource type and its examples in /reference/concepts/trn
- the `pipeline.resolver.executed` event type and the `pipelines` key in
  its payload
- the `CreatePipelineService` API method name

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
@murayama-r
murayama-r requested a review from a team as a code owner August 5, 2026 04:19
@anukiransolur
anukiransolur merged commit 5eab231 into main Aug 5, 2026
3 checks passed
@anukiransolur
anukiransolur deleted the docs/pipeline-to-resolver branch August 5, 2026 18:17
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.

2 participants