# smuhammadtaha3/video-to-guided-docs architecture

> Architecture diagram of the GitHub repository smuhammadtaha3/video-to-guided-docs, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-02). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/smuhammadtaha3/video-to-guided-docs
- Repository: https://github.com/smuhammadtaha3/video-to-guided-docs

## Overview

YouTube Video to Guided Doc accepts a video URL through its web form or API, validates processing options, retrieves video metadata and transcripts (and optionally comments), then formats AI-friendly documentation for display or S3 publication. The main processing path is visible in the excerpts; the README documents caching, multilingual transcripts, comments, rate limits, and cloud integrations. Some utility-module usage and cache wiring are not shown, so those relationships are omitted or marked unverified.

Main entry points: [`src/server/routers/dynamic.py`](https://github.com/smuhammadtaha3/video-to-guided-docs/blob/main/src/server/routers/dynamic.py) (Video routes), [`src/server/query_processor.py`](https://github.com/smuhammadtaha3/video-to-guided-docs/blob/main/src/server/query_processor.py) (Query processing), [`src/server/main.py`](https://github.com/smuhammadtaha3/video-to-guided-docs/blob/main/src/server/main.py) (FastAPI app), [`src/server/routers/index.py`](https://github.com/smuhammadtaha3/video-to-guided-docs/blob/main/src/server/routers/index.py) (Home routes)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_web["Web application"]
  node_app["FastAPI app<br/>[main.py]"]
  node_home["Home routes<br/>[index.py]"]
  node_video_routes["Video routes<br/>[dynamic.py]"]
  node_templates["Web templates"]
end

subgraph group_processing["Video processing"]
  node_query["Query processing<br/>[query_processor.py]"]
  node_schema["Query and video schemas<br/>[video_schema.py]"]
  node_youtube["YouTube extraction"]
end

subgraph group_content["Documentation output"]
  node_documentation["Markdown generation<br/>[query_processor.py]"]
  node_s3_uploader["S3 publishing and cache<br/>[s3_uploader.py]"]
end

subgraph group_support["Shared utilities"]
  node_server_config["Server configuration<br/>[server_config.py]"]
  node_server_utils["Rate limiting and lifecycle<br/>[server_utils.py]"]
  node_text_utils["Text utilities<br/>[text_utils.py]"]
  node_url_utils["URL utilities<br/>[url_utils.py]"]
end

node_user(("User or API client"))
node_youtube_service(("YouTube"))
node_s3[("AWS S3")]

node_user -->|"sends request"| node_app
node_app -->|"registers routes"| node_home
node_app -->|"registers routes"| node_video_routes
node_home -->|"processes submission"| node_query
node_video_routes -->|"processes submission"| node_query
node_home -->|"renders page"| node_templates
node_video_routes -->|"renders page"| node_templates
node_query -->|"processes video"| node_youtube
node_video_routes -->|"streams processing"| node_youtube
node_youtube -->|"retrieves video data"| node_youtube_service
node_query -->|"generates Markdown"| node_documentation
node_query -->|"uploads Markdown"| node_s3_uploader
node_s3_uploader -->|"checks and writes objects"| node_s3
node_video_routes -.->|"checks cache"| node_s3_uploader
node_app -->|"configures lifecycle"| node_server_utils
node_home -->|"applies rate limit"| node_server_utils
node_video_routes -->|"applies rate limit"| node_server_utils
node_query -->|"uses query schema"| node_schema
node_app -->|"uses templates"| node_server_config

click node_app "https://github.com/smuhammadtaha3/video-to-guided-docs/blob/main/src/server/main.py"
click node_home "https://github.com/smuhammadtaha3/video-to-guided-docs/blob/main/src/server/routers/index.py"
click node_video_routes "https://github.com/smuhammadtaha3/video-to-guided-docs/blob/main/src/server/routers/dynamic.py"
click node_templates "https://github.com/smuhammadtaha3/video-to-guided-docs/tree/main/src/server/templates"
click node_query "https://github.com/smuhammadtaha3/video-to-guided-docs/blob/main/src/server/query_processor.py"
click node_schema "https://github.com/smuhammadtaha3/video-to-guided-docs/blob/main/src/youtubedoc/schemas/video_schema.py"
click node_youtube "https://github.com/smuhammadtaha3/video-to-guided-docs/blob/main/src/youtubedoc/youtube_processor.py"
click node_documentation "https://github.com/smuhammadtaha3/video-to-guided-docs/blob/main/src/server/query_processor.py"
click node_s3_uploader "https://github.com/smuhammadtaha3/video-to-guided-docs/blob/main/src/youtubedoc/utils/s3_uploader.py"
click node_server_config "https://github.com/smuhammadtaha3/video-to-guided-docs/blob/main/src/server/server_config.py"
click node_server_utils "https://github.com/smuhammadtaha3/video-to-guided-docs/blob/main/src/server/server_utils.py"
click node_text_utils "https://github.com/smuhammadtaha3/video-to-guided-docs/blob/main/src/youtubedoc/utils/text_utils.py"
click node_url_utils "https://github.com/smuhammadtaha3/video-to-guided-docs/blob/main/src/youtubedoc/utils/url_utils.py"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_app,node_home,node_video_routes,node_templates,node_user toneBlue
class node_query,node_schema,node_youtube,node_s3 toneAmber
class node_documentation,node_s3_uploader toneMint
class node_server_config,node_server_utils,node_text_utils,node_url_utils toneRose
class node_youtube_service toneIndigo
```

## Components

### Web application

- [FastAPI app](https://github.com/smuhammadtaha3/video-to-guided-docs/blob/main/src/server/main.py): `src/server/main.py`
- [Home routes](https://github.com/smuhammadtaha3/video-to-guided-docs/blob/main/src/server/routers/index.py): `src/server/routers/index.py`
- [Video routes](https://github.com/smuhammadtaha3/video-to-guided-docs/blob/main/src/server/routers/dynamic.py): `src/server/routers/dynamic.py`
- [Web templates](https://github.com/smuhammadtaha3/video-to-guided-docs/tree/main/src/server/templates): `src/server/templates`

### Video processing

- [Query processing](https://github.com/smuhammadtaha3/video-to-guided-docs/blob/main/src/server/query_processor.py): `src/server/query_processor.py`
- [Query and video schemas](https://github.com/smuhammadtaha3/video-to-guided-docs/blob/main/src/youtubedoc/schemas/video_schema.py): `src/youtubedoc/schemas/video_schema.py`
- [YouTube extraction](https://github.com/smuhammadtaha3/video-to-guided-docs/blob/main/src/youtubedoc/youtube_processor.py): `src/youtubedoc/youtube_processor.py`

### Documentation output

- [Markdown generation](https://github.com/smuhammadtaha3/video-to-guided-docs/blob/main/src/server/query_processor.py): `src/server/query_processor.py`
- [S3 publishing and cache](https://github.com/smuhammadtaha3/video-to-guided-docs/blob/main/src/youtubedoc/utils/s3_uploader.py): `src/youtubedoc/utils/s3_uploader.py`

### Shared utilities

- [Server configuration](https://github.com/smuhammadtaha3/video-to-guided-docs/blob/main/src/server/server_config.py): `src/server/server_config.py`
- [Rate limiting and lifecycle](https://github.com/smuhammadtaha3/video-to-guided-docs/blob/main/src/server/server_utils.py): `src/server/server_utils.py`
- [Text utilities](https://github.com/smuhammadtaha3/video-to-guided-docs/blob/main/src/youtubedoc/utils/text_utils.py): `src/youtubedoc/utils/text_utils.py`
- [URL utilities](https://github.com/smuhammadtaha3/video-to-guided-docs/blob/main/src/youtubedoc/utils/url_utils.py): `src/youtubedoc/utils/url_utils.py`

### Other components

- **User or API client**
- **YouTube**
- **AWS S3**

## Connections

- User or API client → FastAPI app: sends request (evidence: `README.md`)
- FastAPI app → Home routes: registers routes (evidence: `src/server/main.py`)
- FastAPI app → Video routes: registers routes (evidence: `src/server/main.py`)
- Home routes → Query processing: processes submission (evidence: `src/server/routers/index.py`)
- Video routes → Query processing: processes submission (evidence: `src/server/routers/dynamic.py`)
- Home routes → Web templates: renders page (evidence: `src/server/routers/index.py`)
- Video routes → Web templates: renders page (evidence: `src/server/routers/dynamic.py`)
- Query processing → YouTube extraction: processes video (evidence: `src/server/query_processor.py`)
- Video routes → YouTube extraction: streams processing (evidence: `src/server/routers/dynamic.py`)
- YouTube extraction → YouTube: retrieves video data (evidence: `README.md`)
- Query processing → Markdown generation: generates Markdown (evidence: `src/server/query_processor.py`)
- Query processing → S3 publishing and cache: uploads Markdown (evidence: `src/server/query_processor.py`)
- S3 publishing and cache → AWS S3: checks and writes objects (evidence: `README.md`)
- Video routes → S3 publishing and cache: checks cache (evidence: `src/server/routers/dynamic.py`)
- FastAPI app → Rate limiting and lifecycle: configures lifecycle (evidence: `src/server/main.py`)
- Home routes → Rate limiting and lifecycle: applies rate limit (evidence: `src/server/routers/index.py`)
- Video routes → Rate limiting and lifecycle: applies rate limit (evidence: `src/server/routers/dynamic.py`)
- Query processing → Query and video schemas: uses query schema (evidence: `src/server/query_processor.py`)
- FastAPI app → Server configuration: uses templates (evidence: `src/server/main.py`)
