Skip to content

Add versioned DocC publishing - #165

Merged
LiYanan2004 merged 2 commits into
LiYanan2004:mainfrom
DocCLab:main
Aug 7, 2026
Merged

Add versioned DocC publishing#165
LiYanan2004 merged 2 commits into
LiYanan2004:mainfrom
DocCLab:main

Conversation

@Kyle-Ye

@Kyle-Ye Kyle-Ye commented Aug 5, 2026

Copy link
Copy Markdown
Contributor

Summary

  • add a .vdc.json configuration that publishes the development branch and the latest two release series
  • upgrade the existing GitHub Pages workflow from a single DocC archive to a cached VersionedDocC build
  • add version selection, version-correct GitHub source links, and adjacent-version public API changes
  • update the README to use the stable versioned GitHub Pages URL

The release list is selected dynamically with releasePolicy.latest: 2; it currently resolves to main, 3.0.0, and 2.7.0 without hard-coding release tags in the configuration.

Why

The existing Pages workflow only publishes the current main documentation. VersionedDocC keeps immutable release documentation available under stable URLs and generates API comparisons from the releases' public symbol graphs.

Preview

Validation

  • built all three documentation versions locally with VersionedDocC 0.0.13
  • verified the version selector, API comparison selector, and GitHub source link in a local browser preview
  • verified 2.7.0 → 3.0.0 produces 78 added, 17 modified, and 37 removed public API entries
  • deployed the fork through the updated workflow: https://github.com/DocCLab/MarkdownView/actions/runs/31041404655
  • confirmed the fork's root, Changes page, and all three documentation versions return HTTP 200

@Kyle-Ye
Kyle-Ye marked this pull request as ready for review August 5, 2026 20:05
Comment thread .github/workflows/build-docs.yaml Outdated
Comment thread .github/workflows/build-docs.yaml Outdated
@Kyle-Ye
Kyle-Ye requested a review from LiYanan2004 August 7, 2026 11:57
@LiYanan2004
LiYanan2004 merged commit 906081e into LiYanan2004:main Aug 7, 2026
6 checks passed
@LiYanan2004

Copy link
Copy Markdown
Owner

@Kyle-Ye Thanks!

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