Skip to content

Migration to MkDocs and GitHub Actions - #1053

Draft
gongyixiao wants to merge 5 commits into
developfrom
enhancement/change_doc_hosting
Draft

Migration to MkDocs and GitHub Actions#1053
gongyixiao wants to merge 5 commits into
developfrom
enhancement/change_doc_hosting

Conversation

@gongyixiao

@gongyixiao gongyixiao commented Feb 6, 2026

Copy link
Copy Markdown
Collaborator

Description

This PR migrates the documentation system from VuePress to MkDocs (Material Theme) and establishes a robust CI/CD pipeline for automatic deployment to GitHub Pages.

Key Changes

  • Documentation System: Replaced VuePress with MkDocs Material.
  • Deployment: Added deploy-docs.yml workflow which uses mike to handle versioned documentation (e.g., separate docs for versions/branches).
  • Cleanup: Removed legacy docs/.vuepress directory, package.json, and .nvmrc.
  • Configuration: Updated MultiQC config files to point to the new documentation URL.

Verification

  • Local build of MkDocs verified.
  • Manual deployment simulation successful.

@netlify

netlify Bot commented Feb 6, 2026

Copy link
Copy Markdown

Deploy Preview for cmotempo failed. Why did it fail? →

⚠️ Continuous deployment needs attention — organization-owned private repository detected.
Upgrade to Pro or change repository settings in order to continue deploying from this repository.
For more information, visit the deploy log and FAQ page.

Name Link
🔨 Latest commit f5667fa
🔍 Latest deploy log https://app.netlify.com/projects/cmotempo/deploys/698566a9565e0a000840ca46

@gongyixiao
gongyixiao marked this pull request as draft February 6, 2026 04:00
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.

1 participant