Repository navigation
docs: versioned publishing with mike + CLAIMED story rewrite - #318
Merged
Merged
Conversation
Switch the docs deployment from a single-copy 'mkdocs gh-deploy' to mike-based multi-version publishing: - Push to main publishes the in-development 'dev' docs. - A release tag vX.Y.Z publishes that version (label X.Y.Z) and updates the 'latest' alias, which the site root redirects to. - Add the mkdocs-material version selector (extra.version: mike) so readers can switch versions from a dropdown. Also rewrite the 'What is CLAIMED?' intro on the docs home page to tell the project's story: it began as a reusable component library, became powerful through the C3 Component Compiler, and now integrates MLX for experiment/asset tracking and terratorch-iterate for HPO/NAS. The layer table is extended to four rows to match. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Signed-off-by: Romeo Kienzler <romeo.kienzler1@ibm.com>
rosielickorish
approved these changes
Jun 29, 2026
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
Two related documentation improvements:
1. Versioned docs publishing (
mike)Replaces the single-copy
mkdocs gh-deploywithmike, mkdocs-material's standard multi-version tool.main→ publishes the in-development docs as thedevversion.vX.Y.Z→ publishes that version (labelledX.Y.Z) and updates thelatestalias; the site root redirects tolatest.extra.version: { provider: mike, default: latest }inmkdocs.yml.The workflow's
pathsfilter was removed because, on GitHub Actions, apathsfilter underpushalso applies to tag pushes — a release tag that doesn't touchdocs/**would otherwise be silently skipped and never publish.2. "What is CLAIMED?" rewrite
Rewrites the docs home-page intro to tell the project's story: CLAIMED started as a reusable component library, became powerful through the C3 Component Compiler (now the centerpiece), and grew by integrating MLX for experiment/asset tracking and terratorch-iterate for HPO/NAS. The layer table is extended from three to four rows to match.
Files
mkdocs.yml— addextra.versionmike block..github/workflows/docs.yml— mike-based deploy, tag trigger, bot git identity.docs/index.md— narrative rewrite + 4-row layer table.Verification
mainshould publishdev; pushing avX.Y.Ztag should publishX.Y.Z+latest. Confirm the version dropdown renders at https://claimed-framework.github.io/claimed/.gh-pagesinto per-version subdirectories (expected).🤖 Generated with Claude Code