# tingaicompass/ai-compass architecture

> Architecture diagram of the GitHub repository tingaicompass/ai-compass, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-08-15). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/tingaicompass/ai-compass
- Repository: https://github.com/tingaicompass/ai-compass

## Overview

##### Project Type and Purpose
- AI-Compass is an open-source, static documentation/learning platform rather than a dynamic full-stack application.
- It aggregates and organizes AI resources (theory, frameworks, applications, tools, courses, community links) into a navigable ecosystem.
- Users browse a static website (hosted via GitHub Pages/Gitee) built from Markdown content.

##### File Structure Analysis
- Top-level folders (e.g., “0.AI导航工具集”, “1.1 Prompt工程”, … “10.阿里开源”) each correspond to a major module of content.
- Each module folder contains a single Markdown file and local assets (e.g., images under “picture”).
- Supporting files:
- README.md / README-EN.md – landing page content and navigation.
- weeklyHighlights/ – time-series content for “weekly highlights.”
- No code directories (src, backend, frontend) indicate this is a purely content-centric site using Markdown.

##### README Insights
- Defines seven core modules:
1. Foundation (基础知识)
2. Tech Frameworks (技术框架)
3. Applied Architectures (应用实践)
4. Products & Tools (产品与工具)
5. Learning Resources (学习资源)
6. Community & Platforms (社区与平台)
7. Enterprise Open Source (企业开源)
- Mentions navigation, search, and external links (GitHub, Gitee, social media).
- Indicates static-site behavior but doesn’t explicitly call out a static site generator (e.g., Jekyll, Hugo).

a. Main Components
- Content Repository (Markdown files + images)
- Static Site Generator (SSG) – transforms Markdown → HTML/CSS/JS
- Hosting (GitHub Pages/Gitee Pages)
- CDN / Static Asset Delivery (for images, CSS, JS)
- Site Navigation & Search (built-in or third-party search widget)
- External Integrations (GitHub, Gitee, social media badges)
b. Relationships and Interactions
- Authors commit Markdown into the Git repo → SSG build pipeline → generated HTML.
- Hosting serves HTML and static assets to end users.
- Navigation component reads site structure (folder tree) to produce menus.
- Search widget indexes generated pages or uses GitHub search.
- External badges/links embed at build time or runtime.
c. Architectural Patterns
- Content-centric, docs-as-code approach.
- Modular directory structure mapping to site navigation.
- Static site generation (no runtime backend).
d. Relevant Technologies
- Git / GitHub / Gitee (version control & hosting)
- Markdown (+ front-matter if any)
- Static Site Generator (e.g., Jekyll, Hugo, MkDocs – choose based on familiarity)
- CDN for picture/asset delivery
- Optional search service (Algolia DocSearch, Lunr.js)

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Content Repository
    subgraph "Content Repository" 
        direction TB
        README["README.md"]:::source
        README_EN["README-EN.md"]:::source
        PICTURE["picture/"]:::source
        WEEKLY["weeklyHighlights/"]:::source

        FOUNDATION["Foundation\n(0.AI导航工具集)"]:::source
        TECH_FW["Tech Frameworks\n(1.1 Prompt工程)"]:::source
        APPL_ARCH["Applied Architectures\n(2.1 LLM训练框架)"]:::source
        PROD_TOOLS["Products & Tools\n(4.AI 应用)"]:::source
        LEARN_RES["Learning Resources\n(6.AI-LLM比赛)"]:::source
        COMMUNITY["Community & Platforms\n(9.学习平台)"]:::source
        ENTERPRISE["Enterprise Open Source\n(10.Datawhale)"]:::source
    end

    %% Build Pipeline
    CONTENT_REPO-->SSG["SSG Build Engine"]:::build
    SSG-->NAV["Site Navigation Generator"]:::build
    SSG-->SEARCH_IDX["Search Indexer"]:::build
    SSG-->GENERATED["Generated Static Site"]:::build

    %% Deployment
    GENERATED-->HOST["GitHub/Gitee Pages"]:::deploy
    HOST-->CDN["CDN (Images/CSS/JS)"]:::deploy
    CDN-->USER["User Browser"]:::deploy

    %% External Integrations
    SEARCH_IDX-->ALGOLIA["Algolia DocSearch"]:::external
    GENERATED-->BADGES["Social Media Badges"]:::external

    %% Click Events
    click README "https://github.com/tingaicompass/ai-compass/blob/main/README.md"
    click README_EN "https://github.com/tingaicompass/ai-compass/blob/main/README-EN.md"
    click PICTURE "https://github.com/tingaicompass/ai-compass/tree/main/picture/"
    click WEEKLY "https://github.com/tingaicompass/ai-compass/tree/main/weeklyHighlights/"
    click FOUNDATION "https://github.com/tingaicompass/ai-compass/tree/main/0.AI导航工具集/"
    click TECH_FW "https://github.com/tingaicompass/ai-compass/tree/main/1.1 Prompt工程/"
    click APPL_ARCH "https://github.com/tingaicompass/ai-compass/tree/main/2.1 LLM训练框架/"
    click PROD_TOOLS "https://github.com/tingaicompass/ai-compass/tree/main/4.AI 应用/"
    click LEARN_RES "https://github.com/tingaicompass/ai-compass/tree/main/6.AI-LLM比赛/"
    click COMMUNITY "https://github.com/tingaicompass/ai-compass/tree/main/9.学习平台/"
    click ENTERPRISE "https://github.com/tingaicompass/ai-compass/tree/main/10.Datawhale/"

    %% Styles
    classDef source fill:#B3D7FF,stroke:#333,stroke-width:1px
    classDef build fill:#C6F5C6,stroke:#333,stroke-width:1px
    classDef deploy fill:#FFD9A6,stroke:#333,stroke-width:1px
    classDef external fill:#DDDDDD,stroke:#333,stroke-width:1pxologist
```
