cloudflare-stack-docs

The cloudflare-stack-docs project serves as a comprehensive documentation system leveraging Cloudflare's robust infrastructure. Designed for seamless deployment and effective content management, this system incorporates a Retrieval-Augmented Generation (RAG) feature for enhanced search capabilities.

Key Features

• Dynamic Document Generation: Integrates AI tools for automatic content creation, ensuring documentation remains up-to-date and relevant.
• Cloudflare Infrastructure: Utilizes Cloudflare Workers for hosting, combined with R2 storage for efficient document management and retrieval.
• AI Search Functionality: Employs Cloudflare AI Search to provide intuitive search capabilities within the documentation, improving user experience and accessibility.

Architecture Overview

The architecture of the cloudflare-stack-docs project is well-structured to facilitate both development and deployment:

graph LR
    User[User]

    subgraph dev["Development"]
        LocalRepo[Local Docs<br/>Repository]
        ProjectRepo[Project<br/>Repository]
        AI[Claude Code<br/>Codex etc.]
    end

    subgraph cicd["CI/CD"]
        GHA[GitHub<br/>Actions]
    end

    subgraph cf["Cloudflare Infrastructure"]
        Workers[Workers<br/>Astro + Starlight]
        R2[(R2<br/>Storage)]
        AISearch[AI Search<br/>RAG]
        Access[Access<br/>Auth]
    end

    %% User actions
    User -->|write| LocalRepo
    User -->|read| Workers
    User -->|search| AISearch

    %% AI document generation
    ProjectRepo -->|ref| AI
    AI -->|generate| LocalRepo

    %% CI/CD flow
    LocalRepo -->|push| GHA
    GHA -->|deploy| Workers
    GHA -->|upload| R2

    %% Infrastructure
    Workers -->|query| AISearch
    AISearch -->|index<br>every 6 hours| R2
    Access -->|protect| Workers

Technology Stack

• Framework:

  • Astro: A static site generator that optimizes documentation hosting.
  • Starlight: An Astro-based theme tailored for documentation purposes.

• Infrastructure:

  • Cloudflare Workers: The primary hosting environment.
  • Cloudflare R2: Object storage solution for document management.
  • Cloudflare AI Search: Provides advanced search functionality powered by RAG.
  • Cloudflare Access: Optional authentication and authorization for securing documents.

• Development Tools:

  • pnpm: A performant package manager.
  • textlint: A Japanese text proofing tool used for maintaining high-quality content, with the integration of specialized rules for technical writing.

This repository is positioned to cater to developers and content creators looking to deploy efficient documentation solutions utilizing Cloudflare's advanced capabilities.