docs: rename guides to canonical cross-SDK filenames (1/3) - #273
Open
ambiorix2099 wants to merge 3 commits into
Open
docs: rename guides to canonical cross-SDK filenames (1/3)#273ambiorix2099 wants to merge 3 commits into
ambiorix2099 wants to merge 3 commits into
Conversation
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>
Codecov Report✅ All modified and coverable lines are covered by tests.
Flags with carried forward coverage won't be shown. Click here to find out more. 🚀 New features to boost your workflow:
|
This was referenced Jul 28, 2026
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>
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
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.
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.
462d0d8git mvs — 0 insertions / 0 deletions6dedeb62241f21Renames
docs/workers_sdk.mddocs/workers.mddocs/workflow_sdk.mddocs/workflows.mddocs/migration_guide.mddocs/upgrading.mddocs/api_client/tls_configuration.mddocs/security.mdRedirect 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. Readingconductor-oss/conductor'sdocs/documentation/clientsdks/go-sdk.mddirectly shows nine links into this repository'sdocs/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:
docs/workers_sdk.mddocs/workers.mddocs/workflow_sdk.mddocs/workflows.mddocs/migration_guide.mddocs/upgrading.mddocs/api_client/tls_configuration.mddocs/security.mdWithout 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:
Review commit-by-commit, not the squashed diff.
462d0d8is 0/0 and shows the renames cleanly; the real changes are 37 lines across6dedeb6and2241f21.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.mdand friends simply aren't there.Worth stating plainly, since it motivated the original request: the Python
docs_cleanupPR also renamedAGENTSPAN_*environment variables toCONDUCTOR_AGENT_*. That half does not apply here — this repo has zero occurrences ofagentspanin any casing, andsdk/settings/env.gois already uniformlyCONDUCTOR_*. No runtime behaviour changes anywhere in this series.Verification
.mdlinks acrossREADME.md,CHANGELOG.md, anddocs/resolve on diskCHANGELOG.md's anchored links intodocs/metrics.mdare 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 surviveWhat follows
docs/README.mdhub,compatibility.md,documentation-parity.md,documentation-standard.md,core-quickstart.md, README restructure, ADR 0001docs_test.go,DockerfileCOPY /docs, lychee link-check workflowBacklog for the pages Go still lacks: #266 #267 #268 #269 #270 #271 #272
🤖 Generated with Claude Code