Skip to content

feat: Add Documentation Versioning (2.5 / 2.6-rc)#633

Merged
BaiyuScope3 merged 3 commits into
mainfrom
feature/docs-versioning
Jan 5, 2026
Merged

feat: Add Documentation Versioning (2.5 / 2.6-rc)#633
BaiyuScope3 merged 3 commits into
mainfrom
feature/docs-versioning

Conversation

@BaiyuScope3

@BaiyuScope3 BaiyuScope3 commented Jan 5, 2026

Copy link
Copy Markdown
Collaborator

What

Adds Mintlify versioning support to allow users to switch between documentation versions.
Adds CI process to automatically deploy 2.6.x branch contents into v2.6-rc tab

Changes

  • Version switcher: Users can now toggle between 2.5 (stable) and 2.6-rc (preview)
  • CI workflow: Automatically syncs docs from 2.6.x branch to v2.6-rc/ folder
  • Local script: npm run sync:docs for local testing
  • Version bump: 2.5.1 → 2.5.2

How it works

Push to 2.6.x branch → GitHub Action syncs → make a copy of from 2.6.x branch /docs to v2.6-rc/docs/ → Mintlify deploys

Testing

npm run sync:docs      # Sync 2.6-rc docs locally
npm run start:mintlify # Preview with version dropdown
image

- Add Mintlify versioning support in docs.json
- Create sync-versioned-docs.yml workflow to sync 2.6.x branch to v2.6-rc
- Add local sync script (scripts/sync-versioned-docs.sh)
- Add npm run sync:docs command
- Update broken-links.yml to trigger after sync workflow
- Sync initial v2.6-rc docs from 2.6.x branch
- Update package.json version to 2.5.2
- Update schema registry adcp_version to 2.5.2
- Add changeset for docs versioning feature
- Update CHANGELOG.md with 2.5.2 release notes
Comment thread docs.json
Comment thread docs.json
Comment thread package.json
- Generated 183 schema files from 2.6.x branch
- Includes bundled schemas (25 files) with resolved $ref
Comment thread dist/schemas/2.6.0/adagents.json
@BaiyuScope3 BaiyuScope3 requested a review from bokelley January 5, 2026 18:24
@BaiyuScope3

BaiyuScope3 commented Jan 5, 2026

Copy link
Copy Markdown
Collaborator Author

Feel free to ignore the files under schemas/2.6.0/ during the code review

@BaiyuScope3 BaiyuScope3 merged commit b8ffd16 into main Jan 5, 2026
6 checks passed
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.

2 participants