Skip to content

docs: versioned publishing with mike + CLAIMED story rewrite - #318

Merged
romeokienzler merged 1 commit into
mainfrom
versioned-docs
Jun 29, 2026
Merged

romeokienzler merged 1 commit into
mainfrom
versioned-docs

Conversation

@romeokienzler

Copy link
Copy Markdown
Member

Summary

Two related documentation improvements:

1. Versioned docs publishing (mike)

Replaces the single-copy mkdocs gh-deploy with mike, mkdocs-material's standard multi-version tool.

  • Push to main → publishes the in-development docs as the dev version.
  • Release tag vX.Y.Z → publishes that version (labelled X.Y.Z) and updates the latest alias; the site root redirects to latest.
  • Adds the material version selector dropdown via extra.version: { provider: mike, default: latest } in mkdocs.yml.

The workflow's paths filter was removed because, on GitHub Actions, a paths filter under push also applies to tag pushes — a release tag that doesn't touch docs/** 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 — add extra.version mike block.
  • .github/workflows/docs.yml — mike-based deploy, tag trigger, bot git identity.
  • docs/index.md — narrative rewrite + 4-row layer table.

Verification

  • After merge, a push to main should publish dev; pushing a vX.Y.Z tag should publish X.Y.Z + latest. Confirm the version dropdown renders at https://claimed-framework.github.io/claimed/.
  • Note: the first mike run reorganises the existing flat gh-pages into per-version subdirectories (expected).

🤖 Generated with Claude Code

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>
@romeokienzler
romeokienzler merged commit 14c4338 into main Jun 29, 2026
7 of 9 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