Skip to content

docs: link SDKs from every Quickstart - #82

Open
acedatacloud-dev wants to merge 1 commit into
feat/attribute-quickstart-acquisitionfrom
docs/add-quickstart-sdk
Open

docs: link SDKs from every Quickstart#82
acedatacloud-dev wants to merge 1 commit into
feat/attribute-quickstart-acquisitionfrom
docs/add-quickstart-sdk

Conversation

@acedatacloud-dev

Copy link
Copy Markdown
Member

Dependency

This PR is intentionally stacked on #80, which labels Quickstart registration traffic. The base PR changes attribution only; this PR adds one SDK next step. Merge/retarget in that order.

Why

All localized Quickstart pages teach a first API request, but none provides a direct next step to the official typed SDKs. The SDK repository already supports Python, TypeScript, and Go, so duplicating SDK documentation inside 18 locale trees would create drift. A single canonical card lets successful Quickstart readers continue into maintained clients.

What changed

  • add one language-neutral SDK card before the closing Quickstart CardGroup in all 18 localized pages;
  • list the canonical package identities: acedatacloud, @acedatacloud/sdk, and Go;
  • link the canonical SDK repository with:
    • utm_source=docs
    • utm_medium=quickstart
    • utm_campaign=docs-sdk
  • add a checker requiring exactly one SDK card and all three client identities in every localized Quickstart;
  • add three focused tests and include them in the existing Docs validation workflow.

Validation

  • base Quickstart acquisition tests — 3/3 passed
  • SDK card tests — 3/3 passed
  • SDK checker — 18 localized pages covered
  • generated-content safeguards — 30/30 passed
  • navigation validator — schema OK, 15 navigated languages
  • git diff feat/attribute-quickstart-acquisition...HEAD --check — clean

Scope boundaries

This PR does not duplicate SDK guides, change Quickstart examples, alter navigation, translate new prose, or modify SDK code. The title and package names are intentionally language-neutral. It is independent of future dedicated SDK landing pages.

Rollback

Revert this commit to remove the card/checker while keeping the base acquisition attribution intact.

🤖 Generated with Claude Code

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

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant