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