Skip to content

docs: rename guides to canonical cross-SDK filenames (1/3) - #273

Open
ambiorix2099 wants to merge 3 commits into
mainfrom
docs/canonical-ia-renames
Open

docs: rename guides to canonical cross-SDK filenames (1/3)#273
ambiorix2099 wants to merge 3 commits into
mainfrom
docs/canonical-ia-renames

Conversation

@ambiorix2099

@ambiorix2099 ambiorix2099 commented Jul 28, 2026

Copy link
Copy Markdown

First of three PRs aligning this SDK's documentation information architecture with the Java and Python SDKs.

This PR is mechanical only. No prose was edited; every judgment call is deferred to PR #274 / #275.

Commit Change
462d0d8 four git mvs — 0 insertions / 0 deletions
6dedeb6 the internal links those renames affected, plus the first redirect stub
2241f21 three further redirect stubs (see correction below)

Renames

Before After
docs/workers_sdk.md docs/workers.md
docs/workflow_sdk.md docs/workflows.md
docs/migration_guide.md docs/upgrading.md
docs/api_client/tls_configuration.md docs/security.md

Redirect stubs — corrected count

An earlier revision of this description said only two paths in the whole rename set were referenced externally. That was wrong. It came from gh search code, which truncates results and is not an exhaustive index. Reading conductor-oss/conductor's docs/documentation/clientsdks/go-sdk.md directly shows nine links into this repository's docs/ tree, covering six retired paths.

Four of those are renamed by this PR, so all four keep a pointer-only stub at the old path:

Stub kept at Points to Upstream line(s)
docs/workers_sdk.md docs/workers.md 147, 255
docs/workflow_sdk.md docs/workflows.md 256
docs/migration_guide.md docs/upgrading.md 252, 258
docs/api_client/tls_configuration.md docs/security.md 260

Without them, five links in the published OSS documentation would 404 the moment this merges. The remaining two upstream-referenced paths are handled in #274.

Repointing the upstream links is tracked in conductor-oss/conductor#1417; all six stubs are deleted together once that lands. PR #275 adds a test asserting they stay pointer-only in the meantime, so they cannot quietly grow back into guides.

Note for reviewers: the diff stat is badly misleading

GitHub reports roughly +1192/-1152, which looks like wholesale content rewriting. It is not. Every one of the four old paths is reoccupied by its stub, so at the PR's end state both the old and new file exist and Git's rename detection has nothing to pair. Locally, with copy detection enabled:

$ git diff --stat -C --find-copies-harder main...HEAD
 10 files changed, 37 insertions(+), 1153 deletions(-)

Review commit-by-commit, not the squashed diff. 462d0d8 is 0/0 and shows the renames cleanly; the real changes are 37 lines across 6dedeb6 and 2241f21.

Why rename at all

The value of canonical filenames is that a reader — or a tool — following the Java/Python convention finds the same page name in any Conductor SDK. Today docs/observability.md and friends simply aren't there.

Worth stating plainly, since it motivated the original request: the Python docs_cleanup PR also renamed AGENTSPAN_* environment variables to CONDUCTOR_AGENT_*. That half does not apply here — this repo has zero occurrences of agentspan in any casing, and sdk/settings/env.go is already uniformly CONDUCTOR_*. No runtime behaviour changes anywhere in this series.

Verification

  • All 55 relative .md links across README.md, CHANGELOG.md, and docs/ resolve on disk
  • All four stubs are 10 lines, contain no code fences, and link to their replacement
  • CHANGELOG.md's anchored links into docs/metrics.md are untouched here; that file is renamed in docs: merge sibling guides, add hub and meta pages, restructure README (2/3) #274, where its headings are preserved verbatim so the anchors survive

What follows

Backlog for the pages Go still lacks: #266 #267 #268 #269 #270 #271 #272

🤖 Generated with Claude Code

ambiorix2099 and others added 2 commits July 28, 2026 16:03
Pure renames, no content changes, so rename detection stays intact.

  docs/workers_sdk.md                  -> docs/workers.md
  docs/workflow_sdk.md                 -> docs/workflows.md
  docs/migration_guide.md              -> docs/upgrading.md
  docs/api_client/tls_configuration.md -> docs/security.md

Aligns filenames with the Java and Python SDKs so a reader or tool
following the convention finds the same page name in any Conductor SDK.

Refs #266 #267 #268 #269 #270 #271 #272

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Repoints the nine internal links affected by the renames:

  README.md                  6 links
  docs/workers.md            1 link (workflow_sdk.md -> workflows.md)
  docs/api_client/README.md  2 links (tls_configuration.md -> ../security.md)

Adds a redirect stub at docs/workers_sdk.md. conductor-oss/conductor links
to that path from docs/documentation/clientsdks/go-sdk.md, so removing it
outright would 404 the published OSS documentation. The stub is pointer-only
and comes out once the upstream reference is updated.

CHANGELOG.md links into docs/metrics.md are untouched here; metrics.md is
renamed in the follow-up content pass, and its anchors move with it.

Refs #266 #267 #268 #269 #270 #271 #272

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
@ambiorix2099 ambiorix2099 added the documentation Improvements or additions to documentation label Jul 28, 2026
@codecov

codecov Bot commented Jul 28, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

Flag Coverage Δ
integration-tests-v4 56.35% <ø> (-0.15%) ⬇️
integration-tests-v5 30.99% <ø> (+1.94%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.
see 3 files with indirect coverage changes

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

conductor-oss/conductor links into this repository's docs/ tree from
docs/documentation/clientsdks/go-sdk.md. An earlier count of those links was
wrong -- it came from GitHub code search, which truncates results. Reading the
upstream file directly shows nine such links, not two.

Adds redirect stubs for the three paths this PR renames that are referenced
upstream, so none of them 404 when this lands:

  docs/migration_guide.md              -> docs/upgrading.md
  docs/workflow_sdk.md                 -> docs/workflows.md
  docs/api_client/tls_configuration.md -> docs/security.md

All stubs now name conductor-oss/conductor#1417, which tracks repointing the
upstream links. Every stub is deleted once that lands.

Refs conductor-oss/conductor#1417

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant