Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 36 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,44 @@

***

## Technical Details

### Content Generation Pipeline

```mermaid
flowchart TD
A["BlogPostTitleSuggestion.generate_content()"] --> B["init_blog_post_content_generation()"]
B --> C["AI: generate outline section titles<br/>(Introduction + middle sections + Conclusion)"]
C --> D["DB: create GeneratedBlogPost + GeneratedBlogPostSection rows"]

D --> E{"For each middle section"}
E --> F["Task: generate research questions for section<br/>(local: 1 question)"]

F --> G{"For each research question"}
G --> H["Task: Exa search for links<br/>(local: 2 links)"]

H --> I{"For each research link"}
I --> J["Task: scrape link with Jina Reader"]
J --> K["Task: analyze link (AI)<br/>summary + contextual summary + answer"]

K --> L{"All links attempted/analyzed?"}
L -- no --> K
L -- yes --> M["Task: synthesize middle section contents (AI)"]

M --> N{"All middle sections have content?"}
N -- yes --> O["Task: generate Introduction + Conclusion (AI)"]
N -- no --> M

O --> P{"All sections (incl. intro/conclusion) have content?"}
P -- yes --> Q["Task: populate GeneratedBlogPost.content<br/>(code: combine sections into final markdown)"]
P -- no --> O
```

## TOC

- [Overview](#overview)
- [Technical Details](#technical-details)
- [Content Generation Pipeline](#content-generation-pipeline)
- [TOC](#toc)
- [Deployment](#deployment)
- [Render](#render)
Expand All @@ -39,9 +74,8 @@
[![Deploy to Render](https://render.com/images/deploy-to-render-button.svg)](https://render.com/deploy?repo=https://github.com/rasulkireev/tuxseo)

The only required env vars are:
- OPENAI_API_KEY
- TAVILY_API_KEY
- GEMINI_API_KEY
- EXA_API_KEY
- PERPLEXITY_API_KEY
- JINA_READER_API_KEY
- KEYWORDS_EVERYWHERE_API_KEY
Expand Down
Empty file added content_generation/__init__.py
Empty file.
1 change: 1 addition & 0 deletions content_generation/admin.py
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Register your models here.
6 changes: 6 additions & 0 deletions content_generation/apps.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
from django.apps import AppConfig


class ContentGenerationConfig(AppConfig):
default_auto_field = "django.db.models.BigAutoField"
name = "content_generation"
Empty file.
Loading