Cloudeval

用於部署前雲端架構審查的MCP伺服器。讓Codex、Cursor、Claude Code和VS Code等AI代理能評估Azure ARM範本、Bicep(編譯為ARM)、即時Azure環境及AWS CloudFormation(測試版),生成架構圖,並從1,650多項檢查中回傳有證據支援的成本、安全性及Well-Architected發現。MCP註冊表名稱:io.github.ganakailabs/cloudeval。

文件

Cloudeval Docs

Documentation for Cloudeval built with MkDocs and Material theme.

Setup

  1. Install dependencies:

    pip install -r requirements.txt
    
  2. Serve documentation locally:

    mkdocs serve
    

    Visit http://127.0.0.1:8000 to view the site.

  3. Build documentation:

    mkdocs build
    

Structure

  • docs/ - Documentation source files
  • mkdocs.yml - MkDocs configuration
  • requirements.txt - Python dependencies
  • .github/workflows/docs.yaml - GitHub Actions workflow for deployment

Deployment

The documentation is automatically deployed to GitHub Pages using GitHub Actions:

  1. Automatic Deployment: On every push to main branch
  2. Manual Deployment: Use workflow dispatch in GitHub Actions
  3. Deployment Process:
    • Builds MkDocs site
    • Pushes to gh-pages branch
    • Deploys via GitHub Pages Actions

Initial Setup

Before the first deployment:

  1. Enable GitHub Pages in repository Settings → Pages (Source: GitHub Actions)
  2. Create gh-pages branch (see DEPLOYMENT.md)
  3. Push the workflow file to trigger deployment

Site URL

Once deployed, the site will be available at:

  • Custom domain: https://docs.cloudeval.ai/ (after DNS configuration)
  • GitHub Pages: https://ganakailabs.github.io/cloudeval/

Custom Domain

This repository is configured to use the custom domain docs.cloudeval.ai.

For Namecheap DNS setup, see NAMECHEAP_DNS_SETUP.md for step-by-step instructions.

For general custom domain information, see docs/CUSTOM_DOMAIN.md.

Documentation