[codex] Separate 3.1 upgrade docs from migrations#5656
Merged
Conversation
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
bokelley
marked this pull request as ready for review
June 21, 2026 05:15
Contributor
There was a problem hiding this comment.
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 atindex.mdx:104-126closes cleanly. - The split heading change at
index.mdx:95(Deep-dive pages→Breaking 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: version3.0(line 70, frozendist/3.0.19snapshot — correctly untouched),3.1(line 680),latest(line 1286).
Follow-ups (non-blocking — file as issues)
- The nav alignment is asymmetric.
index.mdxis a single shared file that renders in both the3.1andlatestversions, and it now advertises all three guides as cards. But the sidebars don't match the cards:3.1group (docs.json:714) gotmedia-buy-statusbut is missing3-0-to-3-1— notable, since the 3.1 badge checklist is exactly the page the 3.1 version most wants in its sidebar.latestgroup (docs.json:1308) got3-0-to-3-1but is missingmedia-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: add3-0-to-3-1to the3.1group andmedia-buy-statusto thelatestgroup so both sidebars match the shared index cards.
Minor nits (non-blocking)
- Card-to-nav order. In the
latestgroup3-0-to-3-1sits right afterindex(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.
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.
Summary
docs.jsonnavigation for the 3.1 and latest docs versions so all 3.1 upgrade guides are present.Closes #5655.
Expert review
docs.json.Validation
node -e "JSON.parse(require('fs').readFileSync('docs.json','utf8')); console.log('docs.json ok')"npm run docs:example-coverage -- --jsonnpm run docs:json-field-audit -- --check(0 new findings vs baseline)git diff --checknpx vitest run server/tests/unit/admin-stripe-customer-link.test.ts server/tests/unit/brand-ownership-route.test.ts --pool=threadsNote: the first commit attempt ran the full precommit suite and hit two unrelated/flaky server unit failures; both failed tests passed when rerun directly.