🗺️ O Ciclo de Integração e Entrega Contínua para Documentação (Docs CI/CD)

flowchart LR
    COMMIT["Push / Pull Request em main"]
    --> GHA["GitHub Actions Runner"]

    GHA --> STEP1["1. Lint & Estilo (markdownlint + Prettier)"]
    GHA --> STEP2["2. Auditoria de Links Quebrados (Lychee CLI)"]
    GHA --> STEP3["3. Build Estático (Jekyll / Docusaurus / MkDocs)"]
    GHA --> STEP4["4. Deploy Automático (GitHub Pages / Cloudflare Pages) ⚡"]

    style COMMIT fill:#ede7f6,stroke:#512da8,stroke-width:2px
    style GHA fill:#fff3e0,stroke:#ff9800,stroke-width:2px
    style STEP1 fill:#e1f5fe,stroke:#03a9f4,stroke-width:1.5px
    style STEP2 fill:#fff9c4,stroke:#fbc02d,stroke-width:1.5px
    style STEP3 fill:#e8f5e9,stroke:#4caf50,stroke-width:1.5px
    style STEP4 fill:#00897b,stroke:#004d40,stroke-width:2px,color:#ffffff

📖 Fundamentos e Aplicação

O elo final do paradigma Docs-as-Code é a automação completa de integração e entrega contínua (CI/CD). Nenhuma documentação deve ir para o ar sem que um robô verifique se todos os links externos e internos continuam respondendo com status 200 OK, garantindo que referências antigas não levem os leitores a páginas 404 Not Found.

Ferramentas de Linha de Frente em CI/CD de Docs:

  1. Lychee Link Checker: O verificador de links mais rápido do mundo, escrito em Rust. Varre milhares de arquivos Markdown e HTML assincronamente verificando conexões HTTPS e âncoras internas.
  2. GitHub Actions (deploy-pages): Action oficial moderna que utiliza tokens OIDC (OpenID Connect) sem a necessidade de chaves de deploy manuais na branch gh-pages.
  3. Branch Protection Rules: Regras do repositório que impedem o merge de qualquer PR caso o pipeline de documentação falhe.