Skip to content

EDU-15259: redirect API reference pages to VTEX Developers Portal#28

Merged
PedroAntunesCosta merged 2 commits into
masterfrom
docs/sunset-and-point-to-dev-portal
May 20, 2026
Merged

EDU-15259: redirect API reference pages to VTEX Developers Portal#28
PedroAntunesCosta merged 2 commits into
masterfrom
docs/sunset-and-point-to-dev-portal

Conversation

@PedroAntunesCosta
Copy link
Copy Markdown
Contributor

@PedroAntunesCosta PedroAntunesCosta commented May 18, 2026

Summary

The VTEX Ads API reference has been migrated to the official VTEX Developers Portal:
developers.vtex.com/docs/api-reference/vtex-ads-api.

This PR adds a localized "page moved" callout to every documentation page under en/docs/, es/docs/, and pt/docs/, pointing readers to the new location. The original content is preserved below the callout so existing readers can still consult it.

Changes

  • 54 files updated in en/docs/, es/docs/, and pt/docs/ (18 per locale).
  • A GitHub [!IMPORTANT] callout is inserted right after each page's first heading; the rest of the page is unchanged.
  • Callout copy is localized per folder (EN / ES / PT); the destination URL is the same (the dev portal article is English-only).
  • READMEs, examples/, old_doc/, assets/, diagrams/, and scripts/ were intentionally left untouched.

Why

  • Points readers to the single source of truth for the VTEX Ads API reference on the official Developers Portal.
  • Preserves discoverability and content continuity for users landing on the old GitHub Pages URLs.
  • Keeps the existing material available as a fallback while readers transition to the new home.

Related Task

EDU-15259

@PedroAntunesCosta PedroAntunesCosta added the documentation Improvements or additions to documentation label May 18, 2026
@PedroAntunesCosta PedroAntunesCosta self-assigned this May 18, 2026
@PedroAntunesCosta PedroAntunesCosta added the documentation Improvements or additions to documentation label May 18, 2026
@PedroAntunesCosta PedroAntunesCosta merged commit bc9ed4c into master May 20, 2026
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.

2 participants