Skip to content

docs: attribute Quickstart acquisition - #80

Open
acedatacloud-dev wants to merge 1 commit into
mainfrom
feat/attribute-quickstart-acquisition
Open

docs: attribute Quickstart acquisition#80
acedatacloud-dev wants to merge 1 commit into
mainfrom
feat/attribute-quickstart-acquisition

Conversation

@acedatacloud-dev

Copy link
Copy Markdown
Member

Why

The Docs Quickstart already provides the correct five-minute path—register, create a credential, make a real request, parse the response, and continue to async APIs—but its registration links are untagged. Users who follow the highest-intent documentation journey therefore appear as direct signups in the existing attribution report.

The first optimization should make the working Quickstart measurable rather than replacing it or adding more pages.

What changed

  • append one canonical acquisition contract to every platform-root signup link in all 18 localized Quickstart pages:
    • utm_source=docs
    • utm_medium=quickstart
    • utm_campaign=docs-quickstart
  • update 34 signup links without changing translated copy, API examples, or deep documentation links;
  • add a checker that discovers every localized */quickstart.mdx page and rejects untagged platform-root links;
  • verify every Quickstart path referenced by docs.json exists;
  • add three focused tests and run both test/checker in the existing Docs PR validation workflow.

Validation

  • python3.12 tests/test_quickstart_acquisition.py — 3/3 passed
  • python3.12 scripts/check_quickstart_acquisition.py — 18 localized pages covered
  • link audit — 34 tagged signup links, 0 untagged platform-root signup links
  • python3.12 tests/test_sync_from_platformbackend.py — 30/30 safeguards passed
  • python3.12 scripts/validate_nav.py — schema OK, 15 navigated languages validated
  • Python compile checks — passed
  • git diff --check — clean

Scope boundaries

This PR does not rewrite the Quickstart, change examples, add navigation, edit API behavior, or alter generated PlatformBackend-sourced guides. Three additional localized files that are not currently in the main navigation are still covered because they are public Quickstart assets and should not retain a different acquisition contract.

No inviter_id is added, so referral ownership is unchanged. Page views and clicks remain leading signals; signup, first API use, and payment stay authoritative in the existing server-side cohort.

Rollback

Revert this commit to restore the untagged links and remove the validation rule. No application deployment or database migration is involved beyond the normal Docs publish.

🤖 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