Skip to content

[codex] Separate 3.1 upgrade docs from migrations#5656

Merged
bokelley merged 1 commit into
mainfrom
adcp-issue-5655
Jun 21, 2026
Merged

[codex] Separate 3.1 upgrade docs from migrations#5656
bokelley merged 1 commit into
mainfrom
adcp-issue-5655

Conversation

@bokelley

Copy link
Copy Markdown
Contributor

Summary

  • Split the migration index card group into breaking v2 -> v3.0 migrations and 3.1 badge prep guides.
  • Add cards for the three 3.1 upgrade docs so they are discoverable from the migration index.
  • Align docs.json navigation for the 3.1 and latest docs versions so all 3.1 upgrade guides are present.
  • Add an empty changeset for the protocol-scoped docs update.

Closes #5655.

Expert review

  • docs-expert: approved the index framing, flagged navigation alignment as blocking; addressed by updating docs.json.
  • copywriter: recommended tighter badge-prep wording; addressed in the new 3.1 section heading, caption, and first card.
  • ad-tech-protocol-expert: no blocking concerns; confirmed the additive 3.1 workflow framing is correct.

Validation

  • node -e "JSON.parse(require('fs').readFileSync('docs.json','utf8')); console.log('docs.json ok')"
  • npm run docs:example-coverage -- --json
  • npm run docs:json-field-audit -- --check (0 new findings vs baseline)
  • git diff --check
  • npx vitest run server/tests/unit/admin-stripe-customer-link.test.ts server/tests/unit/brand-ownership-route.test.ts --pool=threads
  • pre-push: version sync, changeset policy, schema link convention, and Mintlify broken-links all passed

Note: the first commit attempt ran the full precommit suite and hit two unrelated/flaky server unit failures; both failed tests passed when rerun directly.

@mintlify

mintlify Bot commented Jun 21, 2026

Copy link
Copy Markdown

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
adcp 🟢 Ready View Preview Jun 21, 2026, 5:26 AM

💡 Tip: Enable Workflows to automatically generate PRs for you.

@bokelley
bokelley marked this pull request as ready for review June 21, 2026 05:15

@aao-release-bot aao-release-bot Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Clean docs-only split that does the right thing: breaking v2→v3.0 migrations and additive 3.1 badge-prep guides are different audiences, and the index card groups now say so. Approving — with one alignment gap to close in a follow-up, because the PR's own goal is nav alignment and it's half-applied.

Things I checked

  • All three carded targets exist on disk: docs/reference/migration/3-0-to-3-1.mdx, creative-transformers.mdx, media-buy-status.mdx. No 404s, and the new CardGroup at index.mdx:104-126 closes cleanly.
  • The split heading change at index.mdx:95 (Deep-dive pagesBreaking migrations (v2 → v3.0)) leaves the v2→v3.0 card group intact — happy path unchanged.
  • Empty changeset is the right shape for a protocol-scoped docs update — valid frontmatter, no package bumps.
  • Three "AdCP 3.x" nav groups in docs.json: version 3.0 (line 70, frozen dist/3.0.19 snapshot — correctly untouched), 3.1 (line 680), latest (line 1286).

Follow-ups (non-blocking — file as issues)

  • The nav alignment is asymmetric. index.mdx is a single shared file that renders in both the 3.1 and latest versions, and it now advertises all three guides as cards. But the sidebars don't match the cards:
    • 3.1 group (docs.json:714) got media-buy-status but is missing 3-0-to-3-1 — notable, since the 3.1 badge checklist is exactly the page the 3.1 version most wants in its sidebar.
    • latest group (docs.json:1308) got 3-0-to-3-1 but is missing media-buy-status.
      Each version's index page links to a page that isn't in that version's sidebar tree. The pages still resolve via the cards (files exist, broken-link check passed), so it's a discoverability gap, not a break. The fix is one line per group: add 3-0-to-3-1 to the 3.1 group and media-buy-status to the latest group so both sidebars match the shared index cards.

Minor nits (non-blocking)

  1. Card-to-nav order. In the latest group 3-0-to-3-1 sits right after index (docs.json:1308), but in the new index card group it's the first 3.1 card — consistent enough, just worth keeping the sidebar order tracking the card order if you touch this again.

LGTM. Alignment follow-up noted above.

@bokelley
bokelley merged commit 0e50d89 into main Jun 21, 2026
20 of 21 checks passed
@bokelley
bokelley deleted the adcp-issue-5655 branch June 21, 2026 09:54
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.

Docs: "Migration" section conflates breaking v3.0 migrations with additive 3.1 upgrades

1 participant